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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC vs.
Revision 1.68 by root, Mon Jan 9 20:00:31 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
		272	=item on_key_press $term, $event, $octets
		273
		274	=item on_key_release $term, $event
		275
		276	=item on_button_press $term, $event
		277
		278	=item on_button_release $term, $event
		279
		280	=item on_motion_notify $term, $event
		281
		282	=item on_map_notify $term, $event
		283
		284	=item on_unmap_notify $term, $event
		285
		286	Called whenever the corresponding X event is received for the terminal If
		287	the hook returns true, then the even will be 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.
		292
		293	C<on_key_press> additionally receives the string rxvt-unicode would
		294	output, if any, in locale-specific encoding.
		295
		296	subwindow.
		297
266	=back	298	=back
267		299
268	=head2 Variables in the C<urxvt> Package	300	=head2 Variables in the C<urxvt> Package
269		301
270	=over 4	302	=over 4
271		303
272	=item $urxvt::TERM	304	=item $urxvt::TERM
273		305
274	The current terminal. Whenever a callback/Hook is bein executed, this	306	The current terminal. This variable stores the current C<urxvt::term>
275	variable stores the current C<urxvt::term> object.	307	object, whenever a callback/hook is executing.
276		308
277	=back	309	=back
278		310
279	=head2 Functions in the C<urxvt> Package	311	=head2 Functions in the C<urxvt> Package
280		312
…		…
301	that calls this function.	333	that calls this function.
302		334
303	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
304	correct place, e.g. on stderr of the connecting urxvtc client.	336	correct place, e.g. on stderr of the connecting urxvtc client.
305		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
306	=item $time = urxvt::NOW	344	=item $time = urxvt::NOW
307		345
308	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.
309		355
310	=back	356	=back
311		357
312	=head2 RENDITION	358	=head2 RENDITION
313		359
…		…
363		409
364	=cut	410	=cut
365		411
366	package urxvt;	412	package urxvt;
367		413
		414	use utf8;
368	use strict;	415	use strict;
369	use Scalar::Util ();	416	use Scalar::Util ();
		417	use List::Util ();
370		418
		419	our $VERSION = 1;
371	our $TERM;	420	our $TERM;
372	our @HOOKNAME;	421	our @HOOKNAME;
		422	our %OPTION;
373	our $LIBDIR;	423	our $LIBDIR;
374		424
375	BEGIN {	425	BEGIN {
376	urxvt->bootstrap;	426	urxvt->bootstrap;
377		427
…		…
380	my $msg = join "", @_;	430	my $msg = join "", @_;
381	$msg .= "\n"	431	$msg .= "\n"
382	unless $msg =~ /\n$/;	432	unless $msg =~ /\n$/;
383	urxvt::warn ($msg);	433	urxvt::warn ($msg);
384	};	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";
385	}	440	}
386		441
387	my @hook_count;	442	my @hook_count;
388	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
389		444
390	sub verbose {	445	sub verbose {
391	my ($level, $msg) = @_;	446	my ($level, $msg) = @_;
392	warn "$msg\n" if $level <= $verbosity;	447	warn "$msg\n" if $level <= $verbosity;
393	}	448	}
394		449
395	# find on_xxx subs in the package and register them	450	my $extension_pkg = "extension0000";
396	# as hooks	451	my %extension_pkg;
397	sub register_package($) {
398	my ($pkg) = @_;
399
400	for my $htype (0.. $#HOOKNAME) {
401	my $name = $HOOKNAME[$htype];
402
403	my $ref = $pkg->can ("on_" . lc $name)
404	or next;
405
406	$TERM->{_hook}[$htype]{$pkg} = $ref;
407	$hook_count[$htype]++
408	or set_should_invoke $htype, 1;
409	}
410	}
411
412	my $script_pkg = "script0000";
413	my %script_pkg;
414		452
415	# load a single script into its own package, once only	453	# load a single script into its own package, once only
416	sub script_package($) {	454	sub extension_package($) {
417	my ($path) = @_;	455	my ($path) = @_;
418		456
419	$script_pkg{$path} \|\|= do {	457	$extension_pkg{$path} \|\|= do {
420	my $pkg = "urxvt::" . ($script_pkg++);	458	my $pkg = "urxvt::" . ($extension_pkg++);
421		459
422	verbose 3, "loading script '$path' into package '$pkg'";	460	verbose 3, "loading extension '$path' into package '$pkg'";
423		461
424	open my $fh, "<:raw", $path	462	open my $fh, "<:raw", $path
425	or die "$path: $!";	463	or die "$path: $!";
426		464
427	my $source = "package $pkg; use strict; use utf8;\n"	465	my $source = untaint "package $pkg; use strict; use utf8;\n"
		466	. "use base urxvt::term::proxy::;\n"
428	. "#line 1 \"$path\"\n{\n"	467	. "#line 1 \"$path\"\n{\n"
429	. (do { local $/; <$fh> })	468	. (do { local $/; <$fh> })
430	. "\n};\n1";	469	. "\n};\n1";
431		470
432	eval $source or die "$path: $@";	471	eval $source or die "$path: $@";
…		…
442	local $TERM = shift;	481	local $TERM = shift;
443	my $htype = shift;	482	my $htype = shift;
444		483
445	if ($htype == 0) { # INIT	484	if ($htype == 0) { # INIT
446	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	485	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		486
		487	my %ext_arg;
447		488
448	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	489	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		490	if ($_ eq "default") {
		491	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup);
		492	} elsif (/^-(.*)$/) {
		493	delete $ext_arg{$1};
		494	} elsif (/^([^<]+)<(.*)>$/) {
		495	push @{ $ext_arg{$1} }, $2;
		496	} else {
		497	$ext_arg{$_} \|\|= [];
		498	}
		499	}
		500
		501	while (my ($ext, $argv) = each %ext_arg) {
449	my @files = grep -f $_, map "$_/$ext", @dirs;	502	my @files = grep -f $_, map "$_/$ext", @dirs;
450		503
451	if (@files) {	504	if (@files) {
452	register_package script_package $files[0];	505	$TERM->register_package (extension_package $files[0], $argv);
453	} else {	506	} else {
454	warn "perl extension '$ext' not found in perl library search path\n";	507	warn "perl extension '$ext' not found in perl library search path\n";
455	}	508	}
456	}	509	}
		510
		511	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		512	warn $@ if $@;
457	}	513	}
458		514
459	$retval = undef;	515	$retval = undef;
460		516
461	if (my $cb = $TERM->{_hook}[$htype]) {	517	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
463	if $verbosity >= 10;	519	if $verbosity >= 10;
464		520
465	keys %$cb;	521	keys %$cb;
466		522
467	while (my ($pkg, $cb) = each %$cb) {	523	while (my ($pkg, $cb) = each %$cb) {
468	$retval = $cb->(	524	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
469	$TERM->{_pkg}{$pkg} \|\|= do {
470	my $proxy = bless { }, urxvt::term::proxy::;
471	Scalar::Util::weaken ($proxy->{term} = $TERM);
472	$proxy
473	},
474	@_,
475	) and last;	525	and last;
		526
		527	if ($@) {
		528	$TERM->ungrab; # better to lose the grab than the session
		529	warn $@;
		530	}
476	}	531	}
477	}	532	}
478		533
479	if ($htype == 1) { # DESTROY	534	if ($htype == 1) { # DESTROY
480	# remove hooks if unused	535	# remove hooks if unused
…		…
493	}	548	}
494		549
495	$retval	550	$retval
496	}	551	}
497		552
		553	# urxvt::term::proxy
		554
498	sub urxvt::term::proxy::AUTOLOAD {	555	sub urxvt::term::proxy::AUTOLOAD {
499	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	556	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
500	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	557	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
501		558
502	eval qq{	559	eval qq{
…		…
508	} or die "FATAL: unable to compile method forwarder: $@";	565	} or die "FATAL: unable to compile method forwarder: $@";
509		566
510	goto &$urxvt::term::proxy::AUTOLOAD;	567	goto &$urxvt::term::proxy::AUTOLOAD;
511	}	568	}
512		569
		570	sub urxvt::term::proxy::DESTROY {
		571	# nop
		572	}
		573
		574	# urxvt::destroy_hook
		575
		576	sub urxvt::destroy_hook::DESTROY {
		577	${$_[0]}->();
		578	}
		579
		580	sub urxvt::destroy_hook(&) {
		581	bless \shift, urxvt::destroy_hook::
		582	}
		583
		584	package urxvt::anyevent;
		585
		586	=head2 The C<urxvt::anyevent> Class
		587
		588	The sole purpose of this class is to deliver an interface to the
		589	C<AnyEvent> module - any module using it will work inside urxvt without
		590	further work. The only exception is that you cannot wait on condition
		591	variables, but non-blocking condvar use is ok. What this means is that you
		592	cannot use blocking APIs, but the non-blocking variant should work.
		593
		594	=cut
		595
		596	our $VERSION = 1;
		597
		598	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		599	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		600
		601	sub timer {
		602	my ($class, %arg) = @_;
		603
		604	my $cb = $arg{cb};
		605
		606	urxvt::timer
		607	->new
		608	->start (urxvt::NOW + $arg{after})
		609	->cb (sub {
		610	$_[0]->stop; # need to cancel manually
		611	$cb->();
		612	})
		613	}
		614
		615	sub io {
		616	my ($class, %arg) = @_;
		617
		618	my $cb = $arg{cb};
		619
		620	bless [$arg{fh}, urxvt::iow
		621	->new
		622	->fd (fileno $arg{fh})
		623	->events (($arg{poll} =~ /r/ ? 1 : 0)
		624	\| ($arg{poll} =~ /w/ ? 2 : 0))
		625	->start
		626	->cb (sub {
		627	$cb->(($_[1] & 1 ? 'r' : '')
		628	. ($_[1] & 2 ? 'w' : ''));
		629	})],
		630	urxvt::anyevent::
		631	}
		632
		633	sub DESTROY {
		634	$_[0][1]->stop;
		635	}
		636
		637	sub condvar {
		638	bless \my $flag, urxvt::anyevent::condvar::
		639	}
		640
		641	sub urxvt::anyevent::condvar::broadcast {
		642	${$_[0]}++;
		643	}
		644
		645	sub urxvt::anyevent::condvar::wait {
		646	unless (${$_[0]}) {
		647	require Carp;
		648	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		649	}
		650	}
		651
		652	package urxvt::term;
		653
513	=head2 The C<urxvt::term> Class	654	=head2 The C<urxvt::term> Class
514		655
515	=over 4	656	=over 4
516		657
		658	=cut
		659
		660	# find on_xxx subs in the package and register them
		661	# as hooks
		662	sub register_package {
		663	my ($self, $pkg, $argv) = @_;
		664
		665	my $proxy = bless { argv => $argv }, $pkg;
		666	Scalar::Util::weaken ($proxy->{term} = $TERM);
		667
		668	$self->{_pkg}{$pkg} = $proxy;
		669
		670	for my $htype (0.. $#HOOKNAME) {
		671	my $name = $HOOKNAME[$htype];
		672
		673	my $ref = $pkg->can ("on_" . lc $name)
		674	or next;
		675
		676	$self->{_hook}[$htype]{$pkg} = $ref;
		677	$hook_count[$htype]++
		678	or urxvt::set_should_invoke $htype, 1;
		679	}
		680	}
		681
517	=item $term->destroy	682	=item $term->destroy
518		683
519	Destroy the terminal object (close the window, free resources etc.).	684	Destroy the terminal object (close the window, free resources etc.).
		685
		686	=item $isset = $term->option ($optval[, $set])
		687
		688	Returns true if the option specified by C<$optval> is enabled, and
		689	optionally change it. All option values are stored by name in the hash
		690	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		691
		692	Here is a a likely non-exhaustive list of option names, please see the
		693	source file F</src/optinc.h> to see the actual list:
		694
		695	borderLess console cursorBlink cursorUnderline hold iconic insecure
		696	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		697	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		698	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		699	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		700	tripleclickwords utmpInhibit visualBell
520		701
521	=item $value = $term->resource ($name[, $newval])	702	=item $value = $term->resource ($name[, $newval])
522		703
523	Returns the current resource value associated with a given name and	704	Returns the current resource value associated with a given name and
524	optionally sets a new value. Setting values is most useful in the C<init>	705	optionally sets a new value. Setting values is most useful in the C<init>
…		…
534		715
535	Please note that resource strings will currently only be freed when the	716	Please note that resource strings will currently only be freed when the
536	terminal is destroyed, so changing options frequently will eat memory.	717	terminal is destroyed, so changing options frequently will eat memory.
537		718
538	Here is a a likely non-exhaustive list of resource names, not all of which	719	Here is a a likely non-exhaustive list of resource names, not all of which
539	are supported in every build, please see the source to see the actual	720	are supported in every build, please see the source file F</src/rsinc.h>
540	list:	721	to see the actual list:
541		722
542	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	723	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
543	borderLess color cursorBlink cursorUnderline cutchars delete_key	724	borderLess color cursorBlink cursorUnderline cutchars delete_key
544	display_name embed ext_bwidth fade font geometry hold iconName	725	display_name embed ext_bwidth fade font geometry hold iconName
545	imFont imLocale inputMethod insecure int_bwidth intensityStyles	726	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
552	shade term_name title transparent transparent_all tripleclickwords	733	shade term_name title transparent transparent_all tripleclickwords
553	utmpInhibit visualBell	734	utmpInhibit visualBell
554		735
555	=cut	736	=cut
556		737
557	sub urxvt::term::resource($$;$) {	738	sub resource($$;$) {
558	my ($self, $name) = (shift, shift);	739	my ($self, $name) = (shift, shift);
559	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	740	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
560	goto &urxvt::term::_resource;	741	&urxvt::term::_resource
561	}	742	}
562		743
563	=item $rend = $term->rstyle ([$new_rstyle])	744	=item $rend = $term->rstyle ([$new_rstyle])
564		745
565	Return and optionally change the current rendition. Text that is output by	746	Return and optionally change the current rendition. Text that is output by
…		…
641		822
642	If hidden, display the overlay again.	823	If hidden, display the overlay again.
643		824
644	=back	825	=back
645		826
		827	=item $popup = $term->popup ($event)
		828
		829	Creates a new C<urxvt::popup> object that implements a popup menu. The
		830	C<$event> I<must> be the event causing the menu to pop up (a button event,
		831	currently).
		832
		833	=cut
		834
		835	sub popup {
		836	my ($self, $event) = @_;
		837
		838	$self->grab ($event->{time}, 1)
		839	or return;
		840
		841	my $popup = bless {
		842	term => $self,
		843	event => $event,
		844	}, urxvt::popup::;
		845
		846	Scalar::Util::weaken $popup->{term};
		847
		848	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		849	Scalar::Util::weaken $self->{_destroy}{$popup};
		850
		851	$popup
		852	}
		853
646	=item $cellwidth = $term->strwidth $string	854	=item $cellwidth = $term->strwidth ($string)
647		855
648	Returns the number of screen-cells this string would need. Correctly	856	Returns the number of screen-cells this string would need. Correctly
649	accounts for wide and combining characters.	857	accounts for wide and combining characters.
650		858
651	=item $octets = $term->locale_encode $string	859	=item $octets = $term->locale_encode ($string)
652		860
653	Convert the given text string into the corresponding locale encoding.	861	Convert the given text string into the corresponding locale encoding.
654		862
655	=item $string = $term->locale_decode $octets	863	=item $string = $term->locale_decode ($octets)
656		864
657	Convert the given locale-encoded octets into a perl string.	865	Convert the given locale-encoded octets into a perl string.
658		866
659	=item $term->scr_add_lines ($string)	867	=item $term->scr_add_lines ($string)
660		868
…		…
677		885
678	Write the octets given in C<$data> to the tty (i.e. as program input). To	886	Write the octets given in C<$data> to the tty (i.e. as program input). To
679	pass characters instead of octets, you should convert your strings first	887	pass characters instead of octets, you should convert your strings first
680	to the locale-specific encoding using C<< $term->locale_encode >>.	888	to the locale-specific encoding using C<< $term->locale_encode >>.
681		889
		890	=item $windowid = $term->parent
		891
		892	Return the window id of the toplevel window.
		893
		894	=item $windowid = $term->vt
		895
		896	Return the window id of the terminal window.
		897
682	=item $window_width = $term->width	898	=item $window_width = $term->width
683		899
684	=item $window_height = $term->height	900	=item $window_height = $term->height
685		901
686	=item $font_width = $term->fwidth	902	=item $font_width = $term->fwidth
…		…
702	=item $nrow_plus_saveLines = $term->total_rows	918	=item $nrow_plus_saveLines = $term->total_rows
703		919
704	=item $lines_in_scrollback = $term->nsaved	920	=item $lines_in_scrollback = $term->nsaved
705		921
706	Return various integers describing terminal characteristics.	922	Return various integers describing terminal characteristics.
		923
		924	=item $lc_ctype = $term->locale
		925
		926	Returns the LC_CTYPE category string used by this rxvt-unicode.
		927
		928	=item $x_display = $term->display_id
		929
		930	Return the DISPLAY used by rxvt-unicode.
		931
		932	=item $modifiermask = $term->ModLevel3Mask
		933
		934	=item $modifiermask = $term->ModMetaMask
		935
		936	=item $modifiermask = $term->ModNumLockMask
		937
		938	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		939	AltGr), the meta key (often Alt) and the num lock key, if applicable.
707		940
708	=item $view_start = $term->view_start ([$newvalue])	941	=item $view_start = $term->view_start ([$newvalue])
709		942
710	Returns the negative row number of the topmost line. Minimum value is	943	Returns the negative row number of the topmost line. Minimum value is
711	C<0>, which displays the normal terminal contents. Larger values scroll	944	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
805		1038
806	=back	1039	=back
807		1040
808	=cut	1041	=cut
809		1042
810	sub urxvt::term::line {	1043	sub line {
811	my ($self, $row) = @_;	1044	my ($self, $row) = @_;
812		1045
813	my $maxrow = $self->nrow - 1;	1046	my $maxrow = $self->nrow - 1;
814		1047
815	my ($beg, $end) = ($row, $row);	1048	my ($beg, $end) = ($row, $row);
…		…
879	$offset / $self->{ncol} + $self->{beg},	1112	$offset / $self->{ncol} + $self->{beg},
880	$offset % $self->{ncol}	1113	$offset % $self->{ncol}
881	)	1114	)
882	}	1115	}
883		1116
884	=item ($row, $col) = $line->coord_of ($offset)
885	=item $text = $term->special_encode $string	1117	=item $text = $term->special_encode $string
886		1118
887	Converts a perl string into the special encoding used by rxvt-unicode,	1119	Converts a perl string into the special encoding used by rxvt-unicode,
888	where one character corresponds to one screen cell. See	1120	where one character corresponds to one screen cell. See
889	C<< $term->ROW_t >> for details.	1121	C<< $term->ROW_t >> for details.
…		…
891	=item $string = $term->special_decode $text	1123	=item $string = $term->special_decode $text
892		1124
893	Converts rxvt-unicodes text reprsentation into a perl string. See	1125	Converts rxvt-unicodes text reprsentation into a perl string. See
894	C<< $term->ROW_t >> for details.	1126	C<< $term->ROW_t >> for details.
895		1127
		1128	=item $success = $term->grab_button ($button, $modifiermask)
		1129
		1130	Registers a synchronous button grab. See the XGrabButton manpage.
		1131
		1132	=item $success = $term->grab ($eventtime[, $sync])
		1133
		1134	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1135	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1136
		1137	=item $term->allow_events_async
		1138
		1139	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1140
		1141	=item $term->allow_events_sync
		1142
		1143	Calls XAllowEvents with SyncBoth for the most recent grab.
		1144
		1145	=item $term->allow_events_replay
		1146
		1147	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1148	recent grab.
		1149
		1150	=item $term->ungrab
		1151
		1152	Calls XUngrab for the most recent grab. Is called automatically on
		1153	evaluation errors, as it is better to lose the grab in the error case as
		1154	the session.
		1155
896	=back	1156	=back
		1157
		1158	=cut
		1159
		1160	package urxvt::popup;
		1161
		1162	=head2 The C<urxvt::popup> Class
		1163
		1164	=over 4
		1165
		1166	=cut
		1167
		1168	sub add_item {
		1169	my ($self, $item) = @_;
		1170
		1171	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1172	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1173	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1174
		1175	$item->{render} \|\|= sub { $_[0]{text} };
		1176
		1177	push @{ $self->{item} }, $item;
		1178	}
		1179
		1180	sub add_separator {
		1181	my ($self, $sep) = @_;
		1182
		1183	$sep \|\|= "=";
		1184
		1185	$self->add_item ({
		1186	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1187	text => "",
		1188	render => sub { $sep x $self->{term}->ncol },
		1189	activate => sub { },
		1190	});
		1191	}
		1192
		1193	sub add_title {
		1194	my ($self, $title) = @_;
		1195
		1196	$self->add_item ({
		1197	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1198	text => $title,
		1199	activate => sub { },
		1200	});
		1201	}
		1202
		1203	sub add_button {
		1204	my ($self, $text, $cb) = @_;
		1205
		1206	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1207	}
		1208
		1209	sub add_toggle {
		1210	my ($self, $text, $cb, $value) = @_;
		1211
		1212	my $item; $item = {
		1213	type => "button",
		1214	text => " $text",
		1215	value => $value,
		1216	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1217	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1218	};
		1219
		1220	$self->add_item ($item);
		1221	}
		1222
		1223	sub show {
		1224	my ($self) = @_;
		1225
		1226	local $urxvt::popup::self = $self;
		1227
		1228	local $ENV{LC_ALL} = $self->{term}->locale;
		1229
		1230	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1231	"--transient-for" => $self->{term}->parent,
		1232	"-display" => $self->{term}->display_id,
		1233	"-pe" => "urxvt-popup")
		1234	or die "unable to create popup window\n";
		1235	}
		1236
		1237	sub DESTROY {
		1238	my ($self) = @_;
		1239
		1240	delete $self->{term}{_destroy}{$self};
		1241	$self->{term}->ungrab;
		1242	}
897		1243
898	=head2 The C<urxvt::timer> Class	1244	=head2 The C<urxvt::timer> Class
899		1245
900	This class implements timer watchers/events. Time is represented as a	1246	This class implements timer watchers/events. Time is represented as a
901	fractional number of seconds since the epoch. Example:	1247	fractional number of seconds since the epoch. Example:
…		…
1003	This variable controls the verbosity level of the perl extension. Higher	1349	This variable controls the verbosity level of the perl extension. Higher
1004	numbers indicate more verbose output.	1350	numbers indicate more verbose output.
1005		1351
1006	=over 4	1352	=over 4
1007		1353
1008	=item =0 - only fatal messages	1354	=item == 0 - fatal messages
1009		1355
1010	=item =3 - script loading and management	1356	=item >= 3 - script loading and management
1011		1357
1012	=item =10 - all events received	1358	=item >=10 - all events received
1013		1359
1014	=back	1360	=back
1015		1361
1016	=head1 AUTHOR	1362	=head1 AUTHOR
1017		1363

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC vs. Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC vs.
Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC