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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.29 by root, Wed Jan 4 00:12:12 2006 UTC vs.
Revision 1.57 by root, Sun Jan 8 08:43:11 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.
		69
		70	=item mark-urls
		71
		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.
64		79
65	=item example-refresh-hooks	80	=item example-refresh-hooks
66		81
67	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
68	window. Illustrates overwriting the refresh callbacks to create your own	83	window. Illustrates overwriting the refresh callbacks to create your own
…		…
81	When objects are destroyed on the C++ side, the perl object hashes are	96	When objects are destroyed on the C++ side, the perl object hashes are
82	emptied, so its best to store related objects such as time watchers and	97	emptied, so its best to store related objects such as time watchers and
83	the like inside the terminal object so they get destroyed as soon as the	98	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	99	terminal is destroyed.
85		100
		101	Argument names also often indicate the type of a parameter. Here are some
		102	hints on what they mean:
		103
		104	=over 4
		105
		106	=item $text
		107
		108	Rxvt-unicodes special way of encoding text, where one "unicode" character
		109	always represents one screen cell. See L<row_t> for a discussion of this format.
		110
		111	=item $string
		112
		113	A perl text string, with an emphasis on I<text>. It can store all unicode
		114	characters and is to be distinguished with text encoded in a specific
		115	encoding (often locale-specific) and binary data.
		116
		117	=item $octets
		118
		119	Either binary data or - more common - a text string encoded in a
		120	locale-specific way.
		121
		122	=back
		123
86	=head2 Hooks	124	=head2 Hooks
87		125
88	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
89	called whenever the relevant event happens.	127	called whenever the relevant event happens.
90		128
91	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
92	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
93	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>
94	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>
95	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.
96		135
97	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
98	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,
99	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.
100		139
…		…
103	=over 4	142	=over 4
104		143
105	=item on_init $term	144	=item on_init $term
106		145
107	Called after a new terminal object has been initialized, but before	146	Called after a new terminal object has been initialized, but before
108	windows are created or the command gets run.	147	windows are created or the command gets run. Most methods are unsafe to
		148	call or deliver senseless data, as terminal size and other characteristics
		149	have not yet been determined. You can safely query and change resources,
		150	though.
109		151
110	=item on_reset $term	152	=item on_reset $term
111		153
112	Called after the screen is "reset" for any reason, such as resizing or	154	Called after the screen is "reset" for any reason, such as resizing or
113	control sequences. Here is where you can react on changes to size-related	155	control sequences. Here is where you can react on changes to size-related
…		…
141	click) and is either supposed to return false (normal operation), or	183	click) and is either supposed to return false (normal operation), or
142	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
143	processing.	185	processing.
144		186
145	See the F<selection> example extension.	187	See the F<selection> example extension.
146
147	=item on_focus_in $term
148
149	Called whenever the window gets the keyboard focus, before urxvt does
150	focus in processing.
151
152	=item on_focus_out $term
153
154	Called wheneever the window loses keyboard focus, before urxvt does focus
155	out processing.
156		188
157	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
158		190
159	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
160	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
185		217
186	Be careful not ever to trust (in a security sense) the data you receive,	218	Be careful not ever to trust (in a security sense) the data you receive,
187	as its source can not easily be controleld (e-mail content, messages from	219	as its source can not easily be controleld (e-mail content, messages from
188	other users on the same system etc.).	220	other users on the same system etc.).
189		221
		222	=item on_add_lines $term, $string
		223
		224	Called whenever text is about to be output, with the text as argument. You
		225	can filter/change and output the text yourself by returning a true value
		226	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		227	might be very slow, however, as your hook is called for B<all> text being
		228	output.
		229
		230	=item on_line_update $term, $row
		231
		232	Called whenever a line was updated or changed. Can be used to filter
		233	screen output (e.g. underline urls or other useless stuff). Only lines
		234	that are being shown will be filtered, and, due to performance reasons,
		235	not always immediately.
		236
		237	The row number is always the topmost row of the line if the line spans
		238	multiple rows.
		239
		240	Please note that, if you change the line, then the hook might get called
		241	later with the already-modified line (e.g. if unrelated parts change), so
		242	you cannot just toggle rendition bits, but only set them.
		243
190	=item on_refresh_begin $term	244	=item on_refresh_begin $term
191		245
192	Called just before the screen gets redrawn. Can be used for overlay	246	Called just before the screen gets redrawn. Can be used for overlay
193	or similar effects by modify terminal contents in refresh_begin, and	247	or similar effects by modify terminal contents in refresh_begin, and
194	restoring them in refresh_end. The built-in overlay and selection display	248	restoring them in refresh_end. The built-in overlay and selection display
…		…
202		256
203	Called whenever the user presses a key combination that has a	257	Called whenever the user presses a key combination that has a
204	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>
205	resource in the @@RXVT_NAME@@(1) manpage).	259	resource in the @@RXVT_NAME@@(1) manpage).
206		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
		271	=item on_key_press $term, $event, $octets
		272
		273	=item on_key_release $term, $event
		274
		275	=item on_button_press $term, $event
		276
		277	=item on_button_release $term, $event
		278
		279	=item on_motion_notify $term, $event
		280
		281	=item on_map_notify $term, $event
		282
		283	=item on_unmap_notify $term, $event
		284
		285	Called whenever the corresponding X event is received for the terminal If
		286	the hook returns true, then the even will be 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.
		291
		292	C<on_key_press> additionally receives the string rxvt-unicode would
		293	output, if any, in locale-specific encoding.
		294
		295	subwindow.
		296
207	=back	297	=back
208		298
209	=head2 Variables in the C<urxvt> Package	299	=head2 Variables in the C<urxvt> Package
210		300
211	=over 4	301	=over 4
212		302
213	=item $urxvt::TERM	303	=item $urxvt::TERM
214		304
215	The current terminal. Whenever a callback/Hook is bein executed, this	305	The current terminal. This variable stores the current C<urxvt::term>
216	variable stores the current C<urxvt::term> object.	306	object, whenever a callback/hook is executing.
217		307
218	=back	308	=back
219		309
220	=head2 Functions in the C<urxvt> Package	310	=head2 Functions in the C<urxvt> Package
221		311
222	=over 4	312	=over 4
		313
		314	=item $term = new urxvt [arg...]
		315
		316	Creates a new terminal, very similar as if you had started it with
		317	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		318	if the new instance couldn't be created. Returns C<undef> if the new
		319	instance didn't initialise perl, and the terminal object otherwise. The
		320	C<init> and C<start> hooks will be called during the call.
223		321
224	=item urxvt::fatal $errormessage	322	=item urxvt::fatal $errormessage
225		323
226	Fatally aborts execution with the given error message. Avoid at all	324	Fatally aborts execution with the given error message. Avoid at all
227	costs! The only time this is acceptable is when the terminal process	325	costs! The only time this is acceptable is when the terminal process
…		…
237	correct place, e.g. on stderr of the connecting urxvtc client.	335	correct place, e.g. on stderr of the connecting urxvtc client.
238		336
239	=item $time = urxvt::NOW	337	=item $time = urxvt::NOW
240		338
241	Returns the "current time" (as per the event loop).	339	Returns the "current time" (as per the event loop).
		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.
242		348
243	=back	349	=back
244		350
245	=head2 RENDITION	351	=head2 RENDITION
246		352
…		…
296		402
297	=cut	403	=cut
298		404
299	package urxvt;	405	package urxvt;
300		406
		407	use utf8;
301	use strict;	408	use strict;
302	use Scalar::Util ();	409	use Scalar::Util ();
		410	use List::Util ();
303		411
		412	our $VERSION = 1;
304	our $TERM;	413	our $TERM;
305	our @HOOKNAME;	414	our @HOOKNAME;
		415	our %OPTION;
306	our $LIBDIR;	416	our $LIBDIR;
307		417
308	BEGIN {	418	BEGIN {
309	urxvt->bootstrap;	419	urxvt->bootstrap;
310		420
…		…
340	$hook_count[$htype]++	450	$hook_count[$htype]++
341	or set_should_invoke $htype, 1;	451	or set_should_invoke $htype, 1;
342	}	452	}
343	}	453	}
344		454
345	my $script_pkg = "script0000";	455	my $extension_pkg = "extension0000";
346	my %script_pkg;	456	my %extension_pkg;
347		457
348	# load a single script into its own package, once only	458	# load a single script into its own package, once only
349	sub script_package($) {	459	sub extension_package($) {
350	my ($path) = @_;	460	my ($path) = @_;
351		461
352	$script_pkg{$path} \|\|= do {	462	$extension_pkg{$path} \|\|= do {
353	my $pkg = "urxvt::" . ($script_pkg++);	463	my $pkg = "urxvt::" . ($extension_pkg++);
354		464
355	verbose 3, "loading script '$path' into package '$pkg'";	465	verbose 3, "loading extension '$path' into package '$pkg'";
356		466
357	open my $fh, "<:raw", $path	467	open my $fh, "<:raw", $path
358	or die "$path: $!";	468	or die "$path: $!";
359		469
360	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"
361	. "#line 1 \"$path\"\n{\n"	472	. "#line 1 \"$path\"\n{\n"
362	. (do { local $/; <$fh> })	473	. (do { local $/; <$fh> })
363	. "\n};\n1";	474	. "\n};\n1";
364		475
		476	$source =~ /(.*)/s and $source = $1; # untaint
		477
365	eval $source or die "$path: $@";	478	eval $source or die "$path: $@";
366		479
367	$pkg	480	$pkg
368	}	481	}
369	}	482	}
		483
		484	our $retval; # return value for urxvt
370		485
371	# called by the rxvt core	486	# called by the rxvt core
372	sub invoke {	487	sub invoke {
373	local $TERM = shift;	488	local $TERM = shift;
374	my $htype = shift;	489	my $htype = shift;
375		490
376	if ($htype == 0) { # INIT	491	if ($htype == 0) { # INIT
377	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	492	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		493
		494	my %want_ext;
378		495
379	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	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) {
380	my @files = grep -f $_, map "$_/$ext", @dirs;	507	my @files = grep -f $_, map "$_/$ext", @dirs;
381		508
382	if (@files) {	509	if (@files) {
383	register_package script_package $files[0];	510	register_package extension_package $files[0];
384	} else {	511	} else {
385	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";
386	}	513	}
387	}	514	}
388		515
		516	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		517	warn $@ if $@;
		518	}
		519
		520	$retval = undef;
		521
		522	if (my $cb = $TERM->{_hook}[$htype]) {
		523	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		524	if $verbosity >= 10;
		525
		526	keys %$cb;
		527
		528	while (my ($pkg, $cb) = each %$cb) {
		529	eval {
		530	$retval = $cb->(
		531	$TERM->{_pkg}{$pkg} \|\|= do {
		532	my $proxy = bless { }, $pkg;
		533	Scalar::Util::weaken ($proxy->{term} = $TERM);
		534	$proxy
		535	},
		536	@_,
		537	) and last;
		538	};
		539	warn $@ if $@;#d#
		540	}
		541	}
		542
389	} elsif ($htype == 1) { # DESTROY	543	if ($htype == 1) { # DESTROY
		544	# remove hooks if unused
390	if (my $hook = $TERM->{_hook}) {	545	if (my $hook = $TERM->{_hook}) {
391	for my $htype (0..$#$hook) {	546	for my $htype (0..$#$hook) {
392	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	547	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
393	or set_should_invoke $htype, 0;	548	or set_should_invoke $htype, 0;
394	}	549	}
395	}	550	}
		551
		552	# clear package objects
		553	%$_ = () for values %{ $TERM->{_pkg} };
		554
		555	# clear package
		556	%$TERM = ();
396	}	557	}
397		558
398	my $cb = $TERM->{_hook}[$htype]	559	$retval
399	or return;
400
401	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
402	if $verbosity >= 10;
403
404	keys %$cb;
405
406	while (my ($pkg, $cb) = each %$cb) {
407	return 1
408	if $cb->(
409	$TERM->{$pkg} \|\|= do {
410	my $proxy = bless { }, urxvt::term::proxy::;
411	Scalar::Util::weaken ($proxy->{term} = $TERM);
412	$proxy
413	},
414	@_,
415	);
416	}
417
418	0
419	}	560	}
		561
		562	# urxvt::term::proxy
420		563
421	sub urxvt::term::proxy::AUTOLOAD {	564	sub urxvt::term::proxy::AUTOLOAD {
422	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	565	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
423	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	566	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
424		567
…		…
431	} or die "FATAL: unable to compile method forwarder: $@";	574	} or die "FATAL: unable to compile method forwarder: $@";
432		575
433	goto &$urxvt::term::proxy::AUTOLOAD;	576	goto &$urxvt::term::proxy::AUTOLOAD;
434	}	577	}
435		578
		579	# urxvt::destroy_hook
		580
		581	sub urxvt::destroy_hook::DESTROY {
		582	${$_[0]}->();
		583	}
		584
		585	sub urxvt::destroy_hook(&) {
		586	bless \shift, urxvt::destroy_hook::
		587	}
		588
		589	package urxvt::anyevent;
		590
		591	=head2 The C<urxvt::anyevent> Class
		592
		593	The sole purpose of this class is to deliver an interface to the
		594	C<AnyEvent> module - any module using it will work inside urxvt without
		595	further work. The only exception is that you cannot wait on condition
		596	variables, but non-blocking condvar use is ok. What this means is that you
		597	cannot use blocking APIs, but the non-blocking variant should work.
		598
		599	=cut
		600
		601	our $VERSION = 1;
		602
		603	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		604	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		605
		606	sub timer {
		607	my ($class, %arg) = @_;
		608
		609	my $cb = $arg{cb};
		610
		611	urxvt::timer
		612	->new
		613	->start (urxvt::NOW + $arg{after})
		614	->cb (sub {
		615	$_[0]->stop; # need to cancel manually
		616	$cb->();
		617	})
		618	}
		619
		620	sub io {
		621	my ($class, %arg) = @_;
		622
		623	my $cb = $arg{cb};
		624
		625	bless [$arg{fh}, urxvt::iow
		626	->new
		627	->fd (fileno $arg{fh})
		628	->events (($arg{poll} =~ /r/ ? 1 : 0)
		629	\| ($arg{poll} =~ /w/ ? 2 : 0))
		630	->start
		631	->cb (sub {
		632	$cb->(($_[1] & 1 ? 'r' : '')
		633	. ($_[1] & 2 ? 'w' : ''));
		634	})],
		635	urxvt::anyevent::
		636	}
		637
		638	sub DESTROY {
		639	$_[0][1]->stop;
		640	}
		641
		642	sub condvar {
		643	bless \my $flag, urxvt::anyevent::condvar::
		644	}
		645
		646	sub urxvt::anyevent::condvar::broadcast {
		647	${$_[0]}++;
		648	}
		649
		650	sub urxvt::anyevent::condvar::wait {
		651	unless (${$_[0]}) {
		652	require Carp;
		653	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		654	}
		655	}
		656
		657	package urxvt::term;
		658
436	=head2 The C<urxvt::term> Class	659	=head2 The C<urxvt::term> Class
437		660
438	=over 4	661	=over 4
		662
		663	=item $term->destroy
		664
		665	Destroy the terminal object (close the window, free resources etc.).
		666
		667	=item $isset = $term->option ($optval[, $set])
		668
		669	Returns true if the option specified by C<$optval> is enabled, and
		670	optionally change it. All option values are stored by name in the hash
		671	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		672
		673	Here is a a likely non-exhaustive list of option names, please see the
		674	source file F</src/optinc.h> to see the actual list:
		675
		676	borderLess console cursorBlink cursorUnderline hold iconic insecure
		677	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		678	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		679	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		680	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		681	tripleclickwords utmpInhibit visualBell
439		682
440	=item $value = $term->resource ($name[, $newval])	683	=item $value = $term->resource ($name[, $newval])
441		684
442	Returns the current resource value associated with a given name and	685	Returns the current resource value associated with a given name and
443	optionally sets a new value. Setting values is most useful in the C<init>	686	optionally sets a new value. Setting values is most useful in the C<init>
…		…
453		696
454	Please note that resource strings will currently only be freed when the	697	Please note that resource strings will currently only be freed when the
455	terminal is destroyed, so changing options frequently will eat memory.	698	terminal is destroyed, so changing options frequently will eat memory.
456		699
457	Here is a a likely non-exhaustive list of resource names, not all of which	700	Here is a a likely non-exhaustive list of resource names, not all of which
458	are supported in every build, please see the source to see the actual	701	are supported in every build, please see the source file F</src/rsinc.h>
459	list:	702	to see the actual list:
460		703
461	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	704	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
462	borderLess color cursorBlink cursorUnderline cutchars delete_key	705	borderLess color cursorBlink cursorUnderline cutchars delete_key
463	display_name embed ext_bwidth fade font geometry hold iconName	706	display_name embed ext_bwidth fade font geometry hold iconName
464	imFont imLocale inputMethod insecure int_bwidth intensityStyles	707	imFont imLocale inputMethod insecure int_bwidth intensityStyles
465	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	708	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
466	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	709	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
467	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	710	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
468	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	711	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
469	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	712	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
470	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	713	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
471	shade term_name title transparent transparent_all tripleclickwords	714	shade term_name title transparent transparent_all tripleclickwords
472	utmpInhibit visualBell	715	utmpInhibit visualBell
473		716
474	=cut	717	=cut
475		718
476	sub urxvt::term::resource($$;$) {	719	sub resource($$;$) {
477	my ($self, $name) = (shift, shift);	720	my ($self, $name) = (shift, shift);
478	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	721	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
479	goto &urxvt::term::_resource;	722	&urxvt::term::_resource
480	}	723	}
		724
		725	=item $rend = $term->rstyle ([$new_rstyle])
		726
		727	Return and optionally change the current rendition. Text that is output by
		728	the terminal application will use this style.
		729
		730	=item ($row, $col) = $term->screen_cur ([$row, $col])
		731
		732	Return the current coordinates of the text cursor position and optionally
		733	set it (which is usually bad as applications don't expect that).
481		734
482	=item ($row, $col) = $term->selection_mark ([$row, $col])	735	=item ($row, $col) = $term->selection_mark ([$row, $col])
483		736
484	=item ($row, $col) = $term->selection_beg ([$row, $col])	737	=item ($row, $col) = $term->selection_beg ([$row, $col])
485		738
…		…
500	#=item $term->overlay ($x, $y, $text)	753	#=item $term->overlay ($x, $y, $text)
501	#	754	#
502	#Create a simple multi-line overlay box. See the next method for details.	755	#Create a simple multi-line overlay box. See the next method for details.
503	#	756	#
504	#=cut	757	#=cut
505		758	#
506	sub urxvt::term::scr_overlay {	759	#sub urxvt::term::scr_overlay {
507	die;
508	my ($self, $x, $y, $text) = @_;	760	# my ($self, $x, $y, $text) = @_;
509		761	#
510	my @lines = split /\n/, $text;	762	# my @lines = split /\n/, $text;
511		763	#
512	my $w = 0;	764	# my $w = 0;
513	for (map $self->strwidth ($_), @lines) {	765	# for (map $self->strwidth ($_), @lines) {
514	$w = $_ if $w < $_;	766	# $w = $_ if $w < $_;
515	}	767	# }
516		768	#
517	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	769	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
518	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	770	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
519	}	771	#}
520		772
521	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	773	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
522		774
523	Create a new (empty) overlay at the given position with the given	775	Create a new (empty) overlay at the given position with the given
524	width/height. C<$rstyle> defines the initial rendition style	776	width/height. C<$rstyle> defines the initial rendition style
…		…
551		803
552	If hidden, display the overlay again.	804	If hidden, display the overlay again.
553		805
554	=back	806	=back
555		807
		808	=item $popup = $term->popup ($event)
		809
		810	Creates a new C<urxvt::popup> object that implements a popup menu. The
		811	C<$event> I<must> be the event causing the menu to pop up (a button event,
		812	currently).
		813
		814	=cut
		815
		816	sub popup {
		817	my ($self, $event) = @_;
		818
		819	$self->grab ($event->{time}, 1)
		820	or return;
		821
		822	my $popup = bless {
		823	term => $self,
		824	event => $event,
		825	}, urxvt::popup::;
		826
		827	Scalar::Util::weaken $popup->{term};
		828
		829	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		830	Scalar::Util::weaken $self->{_destroy}{$popup};
		831
		832	$popup
		833	}
		834
556	=item $cellwidth = $term->strwidth $string	835	=item $cellwidth = $term->strwidth ($string)
557		836
558	Returns the number of screen-cells this string would need. Correctly	837	Returns the number of screen-cells this string would need. Correctly
559	accounts for wide and combining characters.	838	accounts for wide and combining characters.
560		839
561	=item $octets = $term->locale_encode $string	840	=item $octets = $term->locale_encode ($string)
562		841
563	Convert the given text string into the corresponding locale encoding.	842	Convert the given text string into the corresponding locale encoding.
564		843
565	=item $string = $term->locale_decode $octets	844	=item $string = $term->locale_decode ($octets)
566		845
567	Convert the given locale-encoded octets into a perl string.	846	Convert the given locale-encoded octets into a perl string.
		847
		848	=item $term->scr_add_lines ($string)
		849
		850	Write the given text string to the screen, as if output by the application
		851	running inside the terminal. It may not contain command sequences (escape
		852	codes), but is free to use line feeds, carriage returns and tabs. The
		853	string is a normal text string, not in locale-dependent encoding.
		854
		855	Normally its not a good idea to use this function, as programs might be
		856	confused by changes in cursor position or scrolling. Its useful inside a
		857	C<on_add_lines> hook, though.
		858
		859	=item $term->cmd_parse ($octets)
		860
		861	Similar to C<scr_add_lines>, but the argument must be in the
		862	locale-specific encoding of the terminal and can contain command sequences
		863	(escape codes) that will be interpreted.
568		864
569	=item $term->tt_write ($octets)	865	=item $term->tt_write ($octets)
570		866
571	Write the octets given in C<$data> to the tty (i.e. as program input). To	867	Write the octets given in C<$data> to the tty (i.e. as program input). To
572	pass characters instead of octets, you should convert your strings first	868	pass characters instead of octets, you should convert your strings first
573	to the locale-specific encoding using C<< $term->locale_encode >>.	869	to the locale-specific encoding using C<< $term->locale_encode >>.
574		870
		871	=item $windowid = $term->parent
		872
		873	Return the window id of the toplevel window.
		874
		875	=item $windowid = $term->vt
		876
		877	Return the window id of the terminal window.
		878
		879	=item $window_width = $term->width
		880
		881	=item $window_height = $term->height
		882
		883	=item $font_width = $term->fwidth
		884
		885	=item $font_height = $term->fheight
		886
		887	=item $font_ascent = $term->fbase
		888
575	=item $nrow = $term->nrow	889	=item $terminal_rows = $term->nrow
576		890
577	=item $ncol = $term->ncol	891	=item $terminal_columns = $term->ncol
578		892
579	Return the number of rows/columns of the terminal window (i.e. as	893	=item $has_focus = $term->focus
580	specified by C<-geometry>, excluding any scrollback).
581		894
582	=item $nsaved = $term->nsaved	895	=item $is_mapped = $term->mapped
583		896
584	Returns the number of lines in the scrollback buffer.	897	=item $max_scrollback = $term->saveLines
		898
		899	=item $nrow_plus_saveLines = $term->total_rows
		900
		901	=item $lines_in_scrollback = $term->nsaved
		902
		903	Return various integers describing terminal characteristics.
		904
		905	=item $modifiermask = $term->ModLevel3Mask
		906
		907	=item $modifiermask = $term->ModMetaMask
		908
		909	=item $modifiermask = $term->ModNumLockMask
		910
		911	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		912	AltGr), the meta key (often Alt) and the num lock key, if applicable.
585		913
586	=item $view_start = $term->view_start ([$newvalue])	914	=item $view_start = $term->view_start ([$newvalue])
587		915
588	Returns the negative row number of the topmost line. Minimum value is	916	Returns the negative row number of the topmost line. Minimum value is
589	C<0>, which displays the normal terminal contents. Larger values scroll	917	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
652	about the logical line that row C<$row_number> is part of. It supports the	980	about the logical line that row C<$row_number> is part of. It supports the
653	following methods:	981	following methods:
654		982
655	=over 4	983	=over 4
656		984
657	=item $text = $line->t	985	=item $text = $line->t ([$new_text])
658		986
659	Returns the full text of the line, similar to C<ROW_t>	987	Returns or replaces the full text of the line, similar to C<ROW_t>
660		988
661	=item $rend = $line->r	989	=item $rend = $line->r ([$new_rend])
662		990
663	Returns the full rendition array of the line, similar to C<ROW_r>	991	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
664		992
665	=item $length = $line->l	993	=item $length = $line->l
666		994
667	Returns the length of the line in cells, similar to C<ROW_l>.	995	Returns the length of the line in cells, similar to C<ROW_l>.
668		996
…		…
683		1011
684	=back	1012	=back
685		1013
686	=cut	1014	=cut
687		1015
688	sub urxvt::term::line {	1016	sub line {
689	my ($self, $row) = @_;	1017	my ($self, $row) = @_;
690		1018
691	my $maxrow = $self->nrow - 1;	1019	my $maxrow = $self->nrow - 1;
692		1020
693	my ($beg, $end) = ($row, $row);	1021	my ($beg, $end) = ($row, $row);
…		…
697		1025
698	bless {	1026	bless {
699	term => $self,	1027	term => $self,
700	beg => $beg,	1028	beg => $beg,
701	end => $end,	1029	end => $end,
		1030	ncol => $self->ncol,
702	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1031	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
703	}, urxvt::line::	1032	}, urxvt::line::
704	}	1033	}
705		1034
706	sub urxvt::line::t {	1035	sub urxvt::line::t {
707	my ($self) = @_;	1036	my ($self) = @_;
708		1037
		1038	if (@_ > 1)
		1039	{
		1040	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1041	for $self->{beg} .. $self->{end};
		1042	}
		1043
		1044	defined wantarray &&
709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1045	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
710	0, $self->{len}	1046	0, $self->{len}
711	}	1047	}
712		1048
713	sub urxvt::line::r {	1049	sub urxvt::line::r {
714	my ($self) = @_;	1050	my ($self) = @_;
715		1051
		1052	if (@_ > 1)
		1053	{
		1054	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1055	for $self->{beg} .. $self->{end};
		1056	}
		1057
		1058	if (defined wantarray) {
716	my $rend = [	1059	my $rend = [
717	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1060	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
718	];	1061	];
719	$#$rend = $self->{len} - 1;	1062	$#$rend = $self->{len} - 1;
720	$rend	1063	return $rend;
		1064	}
		1065
		1066	()
721	}	1067	}
722		1068
723	sub urxvt::line::beg { $_[0]{beg} }	1069	sub urxvt::line::beg { $_[0]{beg} }
724	sub urxvt::line::end { $_[0]{end} }	1070	sub urxvt::line::end { $_[0]{end} }
725	sub urxvt::line::l { $_[0]{len} }	1071	sub urxvt::line::l { $_[0]{len} }
726		1072
727	sub urxvt::line::offset_of {	1073	sub urxvt::line::offset_of {
728	my ($self, $row, $col) = @_;	1074	my ($self, $row, $col) = @_;
729		1075
730	($row - $self->{beg}) * $self->{term}->ncol + $col	1076	($row - $self->{beg}) * $self->{ncol} + $col
731	}	1077	}
732		1078
733	sub urxvt::line::coord_of {	1079	sub urxvt::line::coord_of {
734	my ($self, $offset) = @_;	1080	my ($self, $offset) = @_;
735		1081
736	use integer;	1082	use integer;
737		1083
738	(	1084	(
739	$offset / $self->{term}->ncol + $self->{beg},	1085	$offset / $self->{ncol} + $self->{beg},
740	$offset % $self->{term}->ncol	1086	$offset % $self->{ncol}
741	)	1087	)
742	}	1088	}
743		1089
744	=item ($row, $col) = $line->coord_of ($offset)	1090	=item ($row, $col) = $line->coord_of ($offset)
745	=item $text = $term->special_encode $string	1091	=item $text = $term->special_encode $string
…		…
752		1098
753	Converts rxvt-unicodes text reprsentation into a perl string. See	1099	Converts rxvt-unicodes text reprsentation into a perl string. See
754	C<< $term->ROW_t >> for details.	1100	C<< $term->ROW_t >> for details.
755		1101
756	=back	1102	=back
		1103
		1104	=cut
		1105
		1106	package urxvt::popup;
		1107
		1108	=head2 The C<urxvt::popup> Class
		1109
		1110	=over 4
		1111
		1112	=cut
		1113
		1114	sub add_item {
		1115	my ($self, $item) = @_;
		1116
		1117	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1118	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1119	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1120
		1121	$item->{render} \|\|= sub { $_[0]{text} };
		1122
		1123	push @{ $self->{item} }, $item;
		1124	}
		1125
		1126	sub add_separator {
		1127	my ($self, $sep) = @_;
		1128
		1129	$sep \|\|= "═";
		1130
		1131	$self->add_item ({
		1132	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1133	text => "",
		1134	render => sub { $sep x $urxvt::TERM->ncol },
		1135	activate => sub { },
		1136	});
		1137	}
		1138
		1139	sub add_title {
		1140	my ($self, $title) = @_;
		1141
		1142	$self->add_item ({
		1143	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1144	text => $title,
		1145	activate => sub { },
		1146	});
		1147	}
		1148
		1149	sub add_button {
		1150	my ($self, $text, $cb) = @_;
		1151
		1152	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1153	}
		1154
		1155	sub add_toggle {
		1156	my ($self, $text, $cb, $value) = @_;
		1157
		1158	my $item; $item = {
		1159	type => "button",
		1160	text => " $text",
		1161	value => $value,
		1162	render => sub { ($item->{value} ? "* " : " ") . $text },
		1163	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1164	};
		1165
		1166	$self->add_item ($item);
		1167	}
		1168
		1169	sub show {
		1170	my ($self) = @_;
		1171
		1172	local $urxvt::popup::self = $self;
		1173
		1174	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1175	"--transient-for" => $self->{term}->parent,
		1176	"-pe" => "urxvt-popup")
		1177	or die "unable to create popup window\n";
		1178	}
		1179
		1180	sub DESTROY {
		1181	my ($self) = @_;
		1182
		1183	$self->{term}->ungrab;
		1184	}
757		1185
758	=head2 The C<urxvt::timer> Class	1186	=head2 The C<urxvt::timer> Class
759		1187
760	This class implements timer watchers/events. Time is represented as a	1188	This class implements timer watchers/events. Time is represented as a
761	fractional number of seconds since the epoch. Example:	1189	fractional number of seconds since the epoch. Example:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.29 by root, Wed Jan 4 00:12:12 2006 UTC vs. Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.29 by root, Wed Jan 4 00:12:12 2006 UTC vs.
Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC