[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.58 by root, Sun Jan 8 22:58:13 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-Button3 that lets you toggle (some) options at
		64	runtime.
		65
61	=item digital-clock	66	=item digital-clock
62		67
63	Displays a digital clock using the built-in overlay.	68	Displays a digital clock using the built-in overlay.
64		69
65	=item mark-urls	70	=item mark-urls
66		71
67	Uses per-line filtering (C<on_line_update>) to underline urls.	72	Uses per-line display filtering (C<on_line_update>) to underline urls.
		73
		74	=item block-graphics-to-ascii
		75
		76	A not very useful example of filtering all text output to the terminal,
		77	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		78	similar-looking ascii character.
68		79
69	=item example-refresh-hooks	80	=item example-refresh-hooks
70		81
71	Displays a very simple digital clock in the upper right corner of the	82	Displays a very simple digital clock in the upper right corner of the
72	window. Illustrates overwriting the refresh callbacks to create your own	83	window. Illustrates overwriting the refresh callbacks to create your own
73	overlays or changes.	84	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		85
82	=back	86	=back
83		87
84	=head2 General API Considerations	88	=head2 General API Considerations
85		89
…		…
117		121
118	=back	122	=back
119		123
120	=head2 Hooks	124	=head2 Hooks
121		125
122	The following subroutines can be declared in loaded scripts, and will be	126	The following subroutines can be declared in extension files, and will be
123	called whenever the relevant event happens.	127	called whenever the relevant event happens.
124		128
125	The first argument passed to them is an object private to each terminal	129	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	130	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>	131	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>	132	object that is shared between all packages is stored in the C<term>
129	member.	133	member. It is, however, blessed intot he package of the extension script,
		134	so for all practical purposes you can treat an extension script as a class.
130		135
131	All of them must return a boolean value. If it is true, then the event	136	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,	137	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.	138	and the relevant action might not be carried out by the C++ code.
134		139
…		…
178	click) and is either supposed to return false (normal operation), or	183	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	184	should extend the selection itelf and return true to suppress the built-in
180	processing.	185	processing.
181		186
182	See the F<selection> example extension.	187	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		188
194	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
195		190
196	Called whenever the view offset changes, i..e the user or program	191	Called whenever the view offset changes, i..e the user or program
197	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
261		256
262	Called whenever the user presses a key combination that has a	257	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>	258	C<perl:string> action bound to it (see description of the B<keysym>
264	resource in the @@RXVT_NAME@@(1) manpage).	259	resource in the @@RXVT_NAME@@(1) manpage).
265		260
		261	=item on_focus_in $term
		262
		263	Called whenever the window gets the keyboard focus, before rxvt-unicode
		264	does focus in processing.
		265
		266	=item on_focus_out $term
		267
		268	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		269	focus out processing.
		270
266	=item on_key_press $term, $event, $octets	271	=item on_key_press $term, $event, $octets
267		272
268	=item on_key_release $term, $event	273	=item on_key_release $term, $event
269		274
270	=item on_button_press $term, $event	275	=item on_button_press $term, $event
271		276
272	=item on_button_release $term, $event	277	=item on_button_release $term, $event
273		278
274	=item on_motion_notify $term, $event	279	=item on_motion_notify $term, $event
275		280
		281	=item on_map_notify $term, $event
		282
		283	=item on_unmap_notify $term, $event
		284
276	Called whenever the corresponding X event is received for the terminal	285	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	286	the hook returns true, then the even will be ignored by rxvt-unicode.
278	ignored by rxvt-unicode.	287
		288	The event is a hash with most values as named by Xlib (see the XEvent
		289	manpage), with the additional members C<row> and C<col>, which are the row
		290	and column under the mouse cursor.
279		291
280	C<on_key_press> additionally receives the string rxvt-unicode would	292	C<on_key_press> additionally receives the string rxvt-unicode would
281	output, if any, in locale-specific encoding.	293	output, if any, in locale-specific encoding.
282		294
283	subwindow.	295	subwindow.
…		…
288		300
289	=over 4	301	=over 4
290		302
291	=item $urxvt::TERM	303	=item $urxvt::TERM
292		304
293	The current terminal. Whenever a callback/Hook is bein executed, this	305	The current terminal. This variable stores the current C<urxvt::term>
294	variable stores the current C<urxvt::term> object.	306	object, whenever a callback/hook is executing.
295		307
296	=back	308	=back
297		309
298	=head2 Functions in the C<urxvt> Package	310	=head2 Functions in the C<urxvt> Package
299		311
…		…
324		336
325	=item $time = urxvt::NOW	337	=item $time = urxvt::NOW
326		338
327	Returns the "current time" (as per the event loop).	339	Returns the "current time" (as per the event loop).
328		340
		341	=item urxvt::CurrentTime
		342
		343	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		344	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		345	Button4Mask, Button5Mask, AnyModifier
		346
		347	Various constants for use in X calls and event processing.
		348
329	=back	349	=back
330		350
331	=head2 RENDITION	351	=head2 RENDITION
332		352
333	Rendition bitsets contain information about colour, font, font styles and	353	Rendition bitsets contain information about colour, font, font styles and
…		…
382		402
383	=cut	403	=cut
384		404
385	package urxvt;	405	package urxvt;
386		406
		407	use utf8;
387	use strict;	408	use strict;
388	use Scalar::Util ();	409	use Scalar::Util ();
		410	use List::Util ();
389		411
		412	our $VERSION = 1;
390	our $TERM;	413	our $TERM;
391	our @HOOKNAME;	414	our @HOOKNAME;
		415	our %OPTION;
392	our $LIBDIR;	416	our $LIBDIR;
393		417
394	BEGIN {	418	BEGIN {
395	urxvt->bootstrap;	419	urxvt->bootstrap;
396		420
…		…
426	$hook_count[$htype]++	450	$hook_count[$htype]++
427	or set_should_invoke $htype, 1;	451	or set_should_invoke $htype, 1;
428	}	452	}
429	}	453	}
430		454
431	my $script_pkg = "script0000";	455	my $extension_pkg = "extension0000";
432	my %script_pkg;	456	my %extension_pkg;
433		457
434	# load a single script into its own package, once only	458	# load a single script into its own package, once only
435	sub script_package($) {	459	sub extension_package($) {
436	my ($path) = @_;	460	my ($path) = @_;
437		461
438	$script_pkg{$path} \|\|= do {	462	$extension_pkg{$path} \|\|= do {
439	my $pkg = "urxvt::" . ($script_pkg++);	463	my $pkg = "urxvt::" . ($extension_pkg++);
440		464
441	verbose 3, "loading script '$path' into package '$pkg'";	465	verbose 3, "loading extension '$path' into package '$pkg'";
442		466
443	open my $fh, "<:raw", $path	467	open my $fh, "<:raw", $path
444	or die "$path: $!";	468	or die "$path: $!";
445		469
446	my $source = "package $pkg; use strict; use utf8;\n"	470	my $source = "package $pkg; use strict; use utf8;\n"
		471	. "use base urxvt::term::proxy::;\n"
447	. "#line 1 \"$path\"\n{\n"	472	. "#line 1 \"$path\"\n{\n"
448	. (do { local $/; <$fh> })	473	. (do { local $/; <$fh> })
449	. "\n};\n1";	474	. "\n};\n1";
		475
		476	$source =~ /(.*)/s and $source = $1; # untaint
450		477
451	eval $source or die "$path: $@";	478	eval $source or die "$path: $@";
452		479
453	$pkg	480	$pkg
454	}	481	}
…		…
461	local $TERM = shift;	488	local $TERM = shift;
462	my $htype = shift;	489	my $htype = shift;
463		490
464	if ($htype == 0) { # INIT	491	if ($htype == 0) { # INIT
465	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	492	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		493
		494	my %want_ext;
466		495
467	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	496	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		497	if ($_ eq "default") {
		498	$want_ext{$_}++ for qw(selection option-popup);
		499	} elsif (/^-(.*)$/) {
		500	delete $want_ext{$1};
		501	} else {
		502	$want_ext{$_}++;
		503	}
		504	}
		505
		506	for my $ext (keys %want_ext) {
468	my @files = grep -f $_, map "$_/$ext", @dirs;	507	my @files = grep -f $_, map "$_/$ext", @dirs;
469		508
470	if (@files) {	509	if (@files) {
471	register_package script_package $files[0];	510	register_package extension_package $files[0];
472	} else {	511	} else {
473	warn "perl extension '$ext' not found in perl library search path\n";	512	warn "perl extension '$ext' not found in perl library search path\n";
474	}	513	}
475	}	514	}
		515
		516	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		517	warn $@ if $@;
476	}	518	}
477		519
478	$retval = undef;	520	$retval = undef;
479		521
480	if (my $cb = $TERM->{_hook}[$htype]) {	522	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
482	if $verbosity >= 10;	524	if $verbosity >= 10;
483		525
484	keys %$cb;	526	keys %$cb;
485		527
486	while (my ($pkg, $cb) = each %$cb) {	528	while (my ($pkg, $cb) = each %$cb) {
		529	eval {
487	$retval = $cb->(	530	$retval = $cb->(
488	$TERM->{_pkg}{$pkg} \|\|= do {	531	$TERM->{_pkg}{$pkg} \|\|= do {
489	my $proxy = bless { }, urxvt::term::proxy::;	532	my $proxy = bless { }, $pkg;
490	Scalar::Util::weaken ($proxy->{term} = $TERM);	533	Scalar::Util::weaken ($proxy->{term} = $TERM);
491	$proxy	534	$proxy
492	},	535	},
493	@_,	536	@_,
494	) and last;	537	) and last;
		538	};
		539	if ($@) {
		540	$TERM->ungrab; # better to lose the grab than the session
		541	warn $@;
		542	}
495	}	543	}
496	}	544	}
497		545
498	if ($htype == 1) { # DESTROY	546	if ($htype == 1) { # DESTROY
499	# remove hooks if unused	547	# remove hooks if unused
…		…
512	}	560	}
513		561
514	$retval	562	$retval
515	}	563	}
516		564
		565	# urxvt::term::proxy
		566
517	sub urxvt::term::proxy::AUTOLOAD {	567	sub urxvt::term::proxy::AUTOLOAD {
518	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	568	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
519	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	569	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
520		570
521	eval qq{	571	eval qq{
…		…
527	} or die "FATAL: unable to compile method forwarder: $@";	577	} or die "FATAL: unable to compile method forwarder: $@";
528		578
529	goto &$urxvt::term::proxy::AUTOLOAD;	579	goto &$urxvt::term::proxy::AUTOLOAD;
530	}	580	}
531		581
		582	sub urxvt::term::proxy::DESTROY {
		583	# nop
		584	}
		585
		586	# urxvt::destroy_hook
		587
		588	sub urxvt::destroy_hook::DESTROY {
		589	${$_[0]}->();
		590	}
		591
		592	sub urxvt::destroy_hook(&) {
		593	bless \shift, urxvt::destroy_hook::
		594	}
		595
		596	package urxvt::anyevent;
		597
		598	=head2 The C<urxvt::anyevent> Class
		599
		600	The sole purpose of this class is to deliver an interface to the
		601	C<AnyEvent> module - any module using it will work inside urxvt without
		602	further work. The only exception is that you cannot wait on condition
		603	variables, but non-blocking condvar use is ok. What this means is that you
		604	cannot use blocking APIs, but the non-blocking variant should work.
		605
		606	=cut
		607
		608	our $VERSION = 1;
		609
		610	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		611	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		612
		613	sub timer {
		614	my ($class, %arg) = @_;
		615
		616	my $cb = $arg{cb};
		617
		618	urxvt::timer
		619	->new
		620	->start (urxvt::NOW + $arg{after})
		621	->cb (sub {
		622	$_[0]->stop; # need to cancel manually
		623	$cb->();
		624	})
		625	}
		626
		627	sub io {
		628	my ($class, %arg) = @_;
		629
		630	my $cb = $arg{cb};
		631
		632	bless [$arg{fh}, urxvt::iow
		633	->new
		634	->fd (fileno $arg{fh})
		635	->events (($arg{poll} =~ /r/ ? 1 : 0)
		636	\| ($arg{poll} =~ /w/ ? 2 : 0))
		637	->start
		638	->cb (sub {
		639	$cb->(($_[1] & 1 ? 'r' : '')
		640	. ($_[1] & 2 ? 'w' : ''));
		641	})],
		642	urxvt::anyevent::
		643	}
		644
		645	sub DESTROY {
		646	$_[0][1]->stop;
		647	}
		648
		649	sub condvar {
		650	bless \my $flag, urxvt::anyevent::condvar::
		651	}
		652
		653	sub urxvt::anyevent::condvar::broadcast {
		654	${$_[0]}++;
		655	}
		656
		657	sub urxvt::anyevent::condvar::wait {
		658	unless (${$_[0]}) {
		659	require Carp;
		660	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		661	}
		662	}
		663
		664	package urxvt::term;
		665
532	=head2 The C<urxvt::term> Class	666	=head2 The C<urxvt::term> Class
533		667
534	=over 4	668	=over 4
535		669
536	=item $term->destroy	670	=item $term->destroy
537		671
538	Destroy the terminal object (close the window, free resources etc.).	672	Destroy the terminal object (close the window, free resources etc.).
		673
		674	=item $isset = $term->option ($optval[, $set])
		675
		676	Returns true if the option specified by C<$optval> is enabled, and
		677	optionally change it. All option values are stored by name in the hash
		678	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		679
		680	Here is a a likely non-exhaustive list of option names, please see the
		681	source file F</src/optinc.h> to see the actual list:
		682
		683	borderLess console cursorBlink cursorUnderline hold iconic insecure
		684	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		685	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		686	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		687	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		688	tripleclickwords utmpInhibit visualBell
539		689
540	=item $value = $term->resource ($name[, $newval])	690	=item $value = $term->resource ($name[, $newval])
541		691
542	Returns the current resource value associated with a given name and	692	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>	693	optionally sets a new value. Setting values is most useful in the C<init>
…		…
553		703
554	Please note that resource strings will currently only be freed when the	704	Please note that resource strings will currently only be freed when the
555	terminal is destroyed, so changing options frequently will eat memory.	705	terminal is destroyed, so changing options frequently will eat memory.
556		706
557	Here is a a likely non-exhaustive list of resource names, not all of which	707	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	708	are supported in every build, please see the source file F</src/rsinc.h>
559	list:	709	to see the actual list:
560		710
561	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	711	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
562	borderLess color cursorBlink cursorUnderline cutchars delete_key	712	borderLess color cursorBlink cursorUnderline cutchars delete_key
563	display_name embed ext_bwidth fade font geometry hold iconName	713	display_name embed ext_bwidth fade font geometry hold iconName
564	imFont imLocale inputMethod insecure int_bwidth intensityStyles	714	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
571	shade term_name title transparent transparent_all tripleclickwords	721	shade term_name title transparent transparent_all tripleclickwords
572	utmpInhibit visualBell	722	utmpInhibit visualBell
573		723
574	=cut	724	=cut
575		725
576	sub urxvt::term::resource($$;$) {	726	sub resource($$;$) {
577	my ($self, $name) = (shift, shift);	727	my ($self, $name) = (shift, shift);
578	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	728	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
579	goto &urxvt::term::_resource;	729	&urxvt::term::_resource
580	}	730	}
581		731
582	=item $rend = $term->rstyle ([$new_rstyle])	732	=item $rend = $term->rstyle ([$new_rstyle])
583		733
584	Return and optionally change the current rendition. Text that is output by	734	Return and optionally change the current rendition. Text that is output by
…		…
660		810
661	If hidden, display the overlay again.	811	If hidden, display the overlay again.
662		812
663	=back	813	=back
664		814
		815	=item $popup = $term->popup ($event)
		816
		817	Creates a new C<urxvt::popup> object that implements a popup menu. The
		818	C<$event> I<must> be the event causing the menu to pop up (a button event,
		819	currently).
		820
		821	=cut
		822
		823	sub popup {
		824	my ($self, $event) = @_;
		825
		826	$self->grab ($event->{time}, 1)
		827	or return;
		828
		829	my $popup = bless {
		830	term => $self,
		831	event => $event,
		832	}, urxvt::popup::;
		833
		834	Scalar::Util::weaken $popup->{term};
		835
		836	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		837	Scalar::Util::weaken $self->{_destroy}{$popup};
		838
		839	$popup
		840	}
		841
665	=item $cellwidth = $term->strwidth $string	842	=item $cellwidth = $term->strwidth ($string)
666		843
667	Returns the number of screen-cells this string would need. Correctly	844	Returns the number of screen-cells this string would need. Correctly
668	accounts for wide and combining characters.	845	accounts for wide and combining characters.
669		846
670	=item $octets = $term->locale_encode $string	847	=item $octets = $term->locale_encode ($string)
671		848
672	Convert the given text string into the corresponding locale encoding.	849	Convert the given text string into the corresponding locale encoding.
673		850
674	=item $string = $term->locale_decode $octets	851	=item $string = $term->locale_decode ($octets)
675		852
676	Convert the given locale-encoded octets into a perl string.	853	Convert the given locale-encoded octets into a perl string.
677		854
678	=item $term->scr_add_lines ($string)	855	=item $term->scr_add_lines ($string)
679		856
…		…
696		873
697	Write the octets given in C<$data> to the tty (i.e. as program input). To	874	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	875	pass characters instead of octets, you should convert your strings first
699	to the locale-specific encoding using C<< $term->locale_encode >>.	876	to the locale-specific encoding using C<< $term->locale_encode >>.
700		877
		878	=item $windowid = $term->parent
		879
		880	Return the window id of the toplevel window.
		881
		882	=item $windowid = $term->vt
		883
		884	Return the window id of the terminal window.
		885
701	=item $window_width = $term->width	886	=item $window_width = $term->width
702		887
703	=item $window_height = $term->height	888	=item $window_height = $term->height
704		889
705	=item $font_width = $term->fwidth	890	=item $font_width = $term->fwidth
…		…
721	=item $nrow_plus_saveLines = $term->total_rows	906	=item $nrow_plus_saveLines = $term->total_rows
722		907
723	=item $lines_in_scrollback = $term->nsaved	908	=item $lines_in_scrollback = $term->nsaved
724		909
725	Return various integers describing terminal characteristics.	910	Return various integers describing terminal characteristics.
		911
		912	=item $modifiermask = $term->ModLevel3Mask
		913
		914	=item $modifiermask = $term->ModMetaMask
		915
		916	=item $modifiermask = $term->ModNumLockMask
		917
		918	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		919	AltGr), the meta key (often Alt) and the num lock key, if applicable.
726		920
727	=item $view_start = $term->view_start ([$newvalue])	921	=item $view_start = $term->view_start ([$newvalue])
728		922
729	Returns the negative row number of the topmost line. Minimum value is	923	Returns the negative row number of the topmost line. Minimum value is
730	C<0>, which displays the normal terminal contents. Larger values scroll	924	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
824		1018
825	=back	1019	=back
826		1020
827	=cut	1021	=cut
828		1022
829	sub urxvt::term::line {	1023	sub line {
830	my ($self, $row) = @_;	1024	my ($self, $row) = @_;
831		1025
832	my $maxrow = $self->nrow - 1;	1026	my $maxrow = $self->nrow - 1;
833		1027
834	my ($beg, $end) = ($row, $row);	1028	my ($beg, $end) = ($row, $row);
…		…
911		1105
912	Converts rxvt-unicodes text reprsentation into a perl string. See	1106	Converts rxvt-unicodes text reprsentation into a perl string. See
913	C<< $term->ROW_t >> for details.	1107	C<< $term->ROW_t >> for details.
914		1108
915	=back	1109	=back
		1110
		1111	=cut
		1112
		1113	package urxvt::popup;
		1114
		1115	=head2 The C<urxvt::popup> Class
		1116
		1117	=over 4
		1118
		1119	=cut
		1120
		1121	sub add_item {
		1122	my ($self, $item) = @_;
		1123
		1124	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1125	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1126	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1127
		1128	$item->{render} \|\|= sub { $_[0]{text} };
		1129
		1130	push @{ $self->{item} }, $item;
		1131	}
		1132
		1133	sub add_separator {
		1134	my ($self, $sep) = @_;
		1135
		1136	$sep \|\|= "═";
		1137
		1138	$self->add_item ({
		1139	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1140	text => "",
		1141	render => sub { $sep x $urxvt::TERM->ncol },
		1142	activate => sub { },
		1143	});
		1144	}
		1145
		1146	sub add_title {
		1147	my ($self, $title) = @_;
		1148
		1149	$self->add_item ({
		1150	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1151	text => $title,
		1152	activate => sub { },
		1153	});
		1154	}
		1155
		1156	sub add_button {
		1157	my ($self, $text, $cb) = @_;
		1158
		1159	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1160	}
		1161
		1162	sub add_toggle {
		1163	my ($self, $text, $cb, $value) = @_;
		1164
		1165	my $item; $item = {
		1166	type => "button",
		1167	text => " $text",
		1168	value => $value,
		1169	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1170	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1171	};
		1172
		1173	$self->add_item ($item);
		1174	}
		1175
		1176	sub show {
		1177	my ($self) = @_;
		1178
		1179	local $urxvt::popup::self = $self;
		1180
		1181	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1182	"--transient-for" => $self->{term}->parent,
		1183	"-pe" => "urxvt-popup")
		1184	or die "unable to create popup window\n";
		1185	}
		1186
		1187	sub DESTROY {
		1188	my ($self) = @_;
		1189
		1190	delete $self->{term}{_destroy}{$self};
		1191	$self->{term}->ungrab;
		1192	}
916		1193
917	=head2 The C<urxvt::timer> Class	1194	=head2 The C<urxvt::timer> Class
918		1195
919	This class implements timer watchers/events. Time is represented as a	1196	This class implements timer watchers/events. Time is represented as a
920	fractional number of seconds since the epoch. Example:	1197	fractional number of seconds since the epoch. Example:
…		…
1022	This variable controls the verbosity level of the perl extension. Higher	1299	This variable controls the verbosity level of the perl extension. Higher
1023	numbers indicate more verbose output.	1300	numbers indicate more verbose output.
1024		1301
1025	=over 4	1302	=over 4
1026		1303
1027	=item =0 - only fatal messages	1304	=item == 0 - fatal messages
1028		1305
1029	=item =3 - script loading and management	1306	=item >= 3 - script loading and management
1030		1307
1031	=item =10 - all events received	1308	=item >=10 - all events received
1032		1309
1033	=back	1310	=back
1034		1311
1035	=head1 AUTHOR	1312	=head1 AUTHOR
1036		1313

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.58 by root, Sun Jan 8 22:58:13 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.58 by root, Sun Jan 8 22:58:13 2006 UTC