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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.25 by root, Tue Jan 3 21:08:39 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 etxension tries to be more intelligent when the user	44	Intelligent selection. This extension tries to be more intelligent when
45	extends selections (double-click).	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,
		47	if your F<ls> supports C<--quoting-style=shell>.
46		48
47	It also offers the following bindable event:	49	It also offers the following bindable event:
48		50
49	=over 4	51	=over 4
50		52
…		…
54		56
55	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
56		58
57	=back	59	=back
58		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
59	=item digital-clock	66	=item digital-clock
60		67
61	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.
62		79
63	=item example-refresh-hooks	80	=item example-refresh-hooks
64		81
65	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
66	window. Illustrates overwriting the refresh callbacks to create your own	83	window. Illustrates overwriting the refresh callbacks to create your own
…		…
79	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
80	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
81	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
82	terminal is destroyed.	99	terminal is destroyed.
83		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
84	=head2 Hooks	124	=head2 Hooks
85		125
86	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
87	called whenever the relevant event happens.	127	called whenever the relevant event happens.
88		128
89	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
90	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
91	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>
92	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>
93	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.
94		135
95	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
96	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,
97	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.
98		139
…		…
101	=over 4	142	=over 4
102		143
103	=item on_init $term	144	=item on_init $term
104		145
105	Called after a new terminal object has been initialized, but before	146	Called after a new terminal object has been initialized, but before
106	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.
107		151
108	=item on_reset $term	152	=item on_reset $term
109		153
110	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
111	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
…		…
140	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
141	processing.	185	processing.
142		186
143	See the F<selection> example extension.	187	See the F<selection> example extension.
144		188
145	=item on_focus_in $term
146
147	Called whenever the window gets the keyboard focus, before urxvt does
148	focus in processing.
149
150	=item on_focus_out $term
151
152	Called wheneever the window loses keyboard focus, before urxvt does focus
153	out processing.
154
155	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
156		190
157	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
158	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
159	show this many lines of scrollback.	193	show this many lines of scrollback.
…		…
169	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
170		204
171	=item on_tty_activity $term NYI	205	=item on_tty_activity $term NYI
172		206
173	Called whenever the program(s) running in the urxvt window send output.	207	Called whenever the program(s) running in the urxvt window send output.
		208
		209	=item on_osc_seq $term, $string
		210
		211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		212	operating system command) is processed. Cursor position and other state
		213	information is up-to-date when this happens. For interoperability, the
		214	string should start with the extension name and a colon, to distinguish
		215	it from commands for other extensions, and this might be enforced in the
		216	future.
		217
		218	Be careful not ever to trust (in a security sense) the data you receive,
		219	as its source can not easily be controleld (e-mail content, messages from
		220	other users on the same system etc.).
		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.
174		243
175	=item on_refresh_begin $term	244	=item on_refresh_begin $term
176		245
177	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
178	or similar effects by modify terminal contents in refresh_begin, and	247	or similar effects by modify terminal contents in refresh_begin, and
…		…
187		256
188	Called whenever the user presses a key combination that has a	257	Called whenever the user presses a key combination that has a
189	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>
190	resource in the @@RXVT_NAME@@(1) manpage).	259	resource in the @@RXVT_NAME@@(1) manpage).
191		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
192	=back	297	=back
193		298
194	=head2 Variables in the C<urxvt> Package	299	=head2 Variables in the C<urxvt> Package
195		300
196	=over 4	301	=over 4
197		302
198	=item $urxvt::TERM	303	=item $urxvt::TERM
199		304
200	The current terminal. Whenever a callback/Hook is bein executed, this	305	The current terminal. This variable stores the current C<urxvt::term>
201	variable stores the current C<urxvt::term> object.	306	object, whenever a callback/hook is executing.
202		307
203	=back	308	=back
204		309
205	=head2 Functions in the C<urxvt> Package	310	=head2 Functions in the C<urxvt> Package
206		311
207	=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.
208		321
209	=item urxvt::fatal $errormessage	322	=item urxvt::fatal $errormessage
210		323
211	Fatally aborts execution with the given error message. Avoid at all	324	Fatally aborts execution with the given error message. Avoid at all
212	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
…		…
222	correct place, e.g. on stderr of the connecting urxvtc client.	335	correct place, e.g. on stderr of the connecting urxvtc client.
223		336
224	=item $time = urxvt::NOW	337	=item $time = urxvt::NOW
225		338
226	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.
227		348
228	=back	349	=back
229		350
230	=head2 RENDITION	351	=head2 RENDITION
231		352
…		…
281		402
282	=cut	403	=cut
283		404
284	package urxvt;	405	package urxvt;
285		406
		407	use utf8;
286	use strict;	408	use strict;
287	use Scalar::Util ();	409	use Scalar::Util ();
		410	use List::Util ();
288		411
		412	our $VERSION = 1;
289	our $TERM;	413	our $TERM;
290	our @HOOKNAME;	414	our @HOOKNAME;
		415	our %OPTION;
291	our $LIBDIR;	416	our $LIBDIR;
292		417
293	BEGIN {	418	BEGIN {
294	urxvt->bootstrap;	419	urxvt->bootstrap;
295		420
…		…
325	$hook_count[$htype]++	450	$hook_count[$htype]++
326	or set_should_invoke $htype, 1;	451	or set_should_invoke $htype, 1;
327	}	452	}
328	}	453	}
329		454
330	my $script_pkg = "script0000";	455	my $extension_pkg = "extension0000";
331	my %script_pkg;	456	my %extension_pkg;
332		457
333	# load a single script into its own package, once only	458	# load a single script into its own package, once only
334	sub script_package($) {	459	sub extension_package($) {
335	my ($path) = @_;	460	my ($path) = @_;
336		461
337	$script_pkg{$path} \|\|= do {	462	$extension_pkg{$path} \|\|= do {
338	my $pkg = "urxvt::" . ($script_pkg++);	463	my $pkg = "urxvt::" . ($extension_pkg++);
339		464
340	verbose 3, "loading script '$path' into package '$pkg'";	465	verbose 3, "loading extension '$path' into package '$pkg'";
341		466
342	open my $fh, "<:raw", $path	467	open my $fh, "<:raw", $path
343	or die "$path: $!";	468	or die "$path: $!";
344		469
345	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"
346	. "#line 1 \"$path\"\n{\n"	472	. "#line 1 \"$path\"\n{\n"
347	. (do { local $/; <$fh> })	473	. (do { local $/; <$fh> })
348	. "\n};\n1";	474	. "\n};\n1";
349		475
		476	$source =~ /(.*)/s and $source = $1; # untaint
		477
350	eval $source or die "$path: $@";	478	eval $source or die "$path: $@";
351		479
352	$pkg	480	$pkg
353	}	481	}
354	}	482	}
		483
		484	our $retval; # return value for urxvt
355		485
356	# called by the rxvt core	486	# called by the rxvt core
357	sub invoke {	487	sub invoke {
358	local $TERM = shift;	488	local $TERM = shift;
359	my $htype = shift;	489	my $htype = shift;
360		490
361	if ($htype == 0) { # INIT	491	if ($htype == 0) { # INIT
362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	492	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		493
		494	my %want_ext;
363		495
364	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) {
365	my @files = grep -f $_, map "$_/$ext", @dirs;	507	my @files = grep -f $_, map "$_/$ext", @dirs;
366		508
367	if (@files) {	509	if (@files) {
368	register_package script_package $files[0];	510	register_package extension_package $files[0];
369	} else {	511	} else {
370	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";
371	}	513	}
372	}	514	}
373		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	if ($@) {
		540	$TERM->ungrab; # better to lose the grab than the session
		541	warn $@;
		542	}
		543	}
		544	}
		545
374	} elsif ($htype == 1) { # DESTROY	546	if ($htype == 1) { # DESTROY
		547	# remove hooks if unused
375	if (my $hook = $TERM->{_hook}) {	548	if (my $hook = $TERM->{_hook}) {
376	for my $htype (0..$#$hook) {	549	for my $htype (0..$#$hook) {
377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	550	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
378	or set_should_invoke $htype, 0;	551	or set_should_invoke $htype, 0;
379	}	552	}
380	}	553	}
		554
		555	# clear package objects
		556	%$_ = () for values %{ $TERM->{_pkg} };
		557
		558	# clear package
		559	%$TERM = ();
381	}	560	}
382		561
383	my $cb = $TERM->{_hook}[$htype]	562	$retval
384	or return;
385
386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
387	if $verbosity >= 10;
388
389	keys %$cb;
390
391	while (my ($pkg, $cb) = each %$cb) {
392	return 1
393	if $cb->(
394	$TERM->{$pkg} \|\|= do {
395	my $proxy = bless { }, urxvt::term::proxy::;
396	Scalar::Util::weaken ($proxy->{term} = $TERM);
397	$proxy
398	},
399	@_,
400	);
401	}
402
403	0
404	}	563	}
		564
		565	# urxvt::term::proxy
405		566
406	sub urxvt::term::proxy::AUTOLOAD {	567	sub urxvt::term::proxy::AUTOLOAD {
407	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	568	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
408	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	569	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
409		570
…		…
416	} or die "FATAL: unable to compile method forwarder: $@";	577	} or die "FATAL: unable to compile method forwarder: $@";
417		578
418	goto &$urxvt::term::proxy::AUTOLOAD;	579	goto &$urxvt::term::proxy::AUTOLOAD;
419	}	580	}
420		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
421	=head2 The C<urxvt::term> Class	666	=head2 The C<urxvt::term> Class
422		667
423	=over 4	668	=over 4
		669
		670	=item $term->destroy
		671
		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
424		689
425	=item $value = $term->resource ($name[, $newval])	690	=item $value = $term->resource ($name[, $newval])
426		691
427	Returns the current resource value associated with a given name and	692	Returns the current resource value associated with a given name and
428	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>
…		…
438		703
439	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
440	terminal is destroyed, so changing options frequently will eat memory.	705	terminal is destroyed, so changing options frequently will eat memory.
441		706
442	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
443	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>
444	list:	709	to see the actual list:
445		710
446	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	711	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447	borderLess color cursorBlink cursorUnderline cutchars delete_key	712	borderLess color cursorBlink cursorUnderline cutchars delete_key
448	display_name embed ext_bwidth fade font geometry hold iconName	713	display_name embed ext_bwidth fade font geometry hold iconName
449	imFont imLocale inputMethod insecure int_bwidth intensityStyles	714	imFont imLocale inputMethod insecure int_bwidth intensityStyles
450	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	715	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
451	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	716	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
452	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	717	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
453	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	718	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
454	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	719	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
455	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	720	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
456	shade term_name title transparent transparent_all tripleclickwords	721	shade term_name title transparent transparent_all tripleclickwords
457	utmpInhibit visualBell	722	utmpInhibit visualBell
458		723
459	=cut	724	=cut
460		725
461	sub urxvt::term::resource($$;$) {	726	sub resource($$;$) {
462	my ($self, $name) = (shift, shift);	727	my ($self, $name) = (shift, shift);
463	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	728	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
464	goto &urxvt::term::_resource;	729	&urxvt::term::_resource
465	}	730	}
		731
		732	=item $rend = $term->rstyle ([$new_rstyle])
		733
		734	Return and optionally change the current rendition. Text that is output by
		735	the terminal application will use this style.
		736
		737	=item ($row, $col) = $term->screen_cur ([$row, $col])
		738
		739	Return the current coordinates of the text cursor position and optionally
		740	set it (which is usually bad as applications don't expect that).
466		741
467	=item ($row, $col) = $term->selection_mark ([$row, $col])	742	=item ($row, $col) = $term->selection_mark ([$row, $col])
468		743
469	=item ($row, $col) = $term->selection_beg ([$row, $col])	744	=item ($row, $col) = $term->selection_beg ([$row, $col])
470		745
…		…
485	#=item $term->overlay ($x, $y, $text)	760	#=item $term->overlay ($x, $y, $text)
486	#	761	#
487	#Create a simple multi-line overlay box. See the next method for details.	762	#Create a simple multi-line overlay box. See the next method for details.
488	#	763	#
489	#=cut	764	#=cut
490		765	#
491	sub urxvt::term::scr_overlay {	766	#sub urxvt::term::scr_overlay {
492	die;
493	my ($self, $x, $y, $text) = @_;	767	# my ($self, $x, $y, $text) = @_;
494		768	#
495	my @lines = split /\n/, $text;	769	# my @lines = split /\n/, $text;
496		770	#
497	my $w = 0;	771	# my $w = 0;
498	for (map $self->strwidth ($_), @lines) {	772	# for (map $self->strwidth ($_), @lines) {
499	$w = $_ if $w < $_;	773	# $w = $_ if $w < $_;
500	}	774	# }
501		775	#
502	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	776	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
503	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	777	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
504	}	778	#}
505		779
506	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	780	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
507		781
508	Create a new (empty) overlay at the given position with the given	782	Create a new (empty) overlay at the given position with the given
509	width/height. C<$rstyle> defines the initial rendition style	783	width/height. C<$rstyle> defines the initial rendition style
…		…
536		810
537	If hidden, display the overlay again.	811	If hidden, display the overlay again.
538		812
539	=back	813	=back
540		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
541	=item $cellwidth = $term->strwidth $string	842	=item $cellwidth = $term->strwidth ($string)
542		843
543	Returns the number of screen-cells this string would need. Correctly	844	Returns the number of screen-cells this string would need. Correctly
544	accounts for wide and combining characters.	845	accounts for wide and combining characters.
545		846
546	=item $octets = $term->locale_encode $string	847	=item $octets = $term->locale_encode ($string)
547		848
548	Convert the given text string into the corresponding locale encoding.	849	Convert the given text string into the corresponding locale encoding.
549		850
550	=item $string = $term->locale_decode $octets	851	=item $string = $term->locale_decode ($octets)
551		852
552	Convert the given locale-encoded octets into a perl string.	853	Convert the given locale-encoded octets into a perl string.
		854
		855	=item $term->scr_add_lines ($string)
		856
		857	Write the given text string to the screen, as if output by the application
		858	running inside the terminal. It may not contain command sequences (escape
		859	codes), but is free to use line feeds, carriage returns and tabs. The
		860	string is a normal text string, not in locale-dependent encoding.
		861
		862	Normally its not a good idea to use this function, as programs might be
		863	confused by changes in cursor position or scrolling. Its useful inside a
		864	C<on_add_lines> hook, though.
		865
		866	=item $term->cmd_parse ($octets)
		867
		868	Similar to C<scr_add_lines>, but the argument must be in the
		869	locale-specific encoding of the terminal and can contain command sequences
		870	(escape codes) that will be interpreted.
553		871
554	=item $term->tt_write ($octets)	872	=item $term->tt_write ($octets)
555		873
556	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
557	pass characters instead of octets, you should convert your strings first	875	pass characters instead of octets, you should convert your strings first
558	to the locale-specific encoding using C<< $term->locale_encode >>.	876	to the locale-specific encoding using C<< $term->locale_encode >>.
559		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
		886	=item $window_width = $term->width
		887
		888	=item $window_height = $term->height
		889
		890	=item $font_width = $term->fwidth
		891
		892	=item $font_height = $term->fheight
		893
		894	=item $font_ascent = $term->fbase
		895
560	=item $nrow = $term->nrow	896	=item $terminal_rows = $term->nrow
561		897
562	=item $ncol = $term->ncol	898	=item $terminal_columns = $term->ncol
563		899
564	Return the number of rows/columns of the terminal window (i.e. as	900	=item $has_focus = $term->focus
565	specified by C<-geometry>, excluding any scrollback).
566		901
567	=item $nsaved = $term->nsaved	902	=item $is_mapped = $term->mapped
568		903
569	Returns the number of lines in the scrollback buffer.	904	=item $max_scrollback = $term->saveLines
		905
		906	=item $nrow_plus_saveLines = $term->total_rows
		907
		908	=item $lines_in_scrollback = $term->nsaved
		909
		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.
570		920
571	=item $view_start = $term->view_start ([$newvalue])	921	=item $view_start = $term->view_start ([$newvalue])
572		922
573	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
574	C<0>, which displays the normal terminal contents. Larger values scroll	924	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
637	about the logical line that row C<$row_number> is part of. It supports the	987	about the logical line that row C<$row_number> is part of. It supports the
638	following methods:	988	following methods:
639		989
640	=over 4	990	=over 4
641		991
642	=item $text = $line->t	992	=item $text = $line->t ([$new_text])
643		993
644	Returns the full text of the line, similar to C<ROW_t>	994	Returns or replaces the full text of the line, similar to C<ROW_t>
645		995
646	=item $rend = $line->r	996	=item $rend = $line->r ([$new_rend])
647		997
648	Returns the full rendition array of the line, similar to C<ROW_r>	998	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
649		999
650	=item $length = $line->l	1000	=item $length = $line->l
651		1001
652	Returns the length of the line in cells, similar to C<ROW_l>.	1002	Returns the length of the line in cells, similar to C<ROW_l>.
653		1003
…		…
668		1018
669	=back	1019	=back
670		1020
671	=cut	1021	=cut
672		1022
673	sub urxvt::term::line {	1023	sub line {
674	my ($self, $row) = @_;	1024	my ($self, $row) = @_;
675		1025
676	my $maxrow = $self->nrow - 1;	1026	my $maxrow = $self->nrow - 1;
677		1027
678	my ($beg, $end) = ($row, $row);	1028	my ($beg, $end) = ($row, $row);
…		…
682		1032
683	bless {	1033	bless {
684	term => $self,	1034	term => $self,
685	beg => $beg,	1035	beg => $beg,
686	end => $end,	1036	end => $end,
		1037	ncol => $self->ncol,
687	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1038	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
688	}, urxvt::line::	1039	}, urxvt::line::
689	}	1040	}
690		1041
691	sub urxvt::line::t {	1042	sub urxvt::line::t {
692	my ($self) = @_;	1043	my ($self) = @_;
693		1044
		1045	if (@_ > 1)
		1046	{
		1047	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1048	for $self->{beg} .. $self->{end};
		1049	}
		1050
		1051	defined wantarray &&
694	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1052	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
695	0, $self->{len}	1053	0, $self->{len}
696	}	1054	}
697		1055
698	sub urxvt::line::r {	1056	sub urxvt::line::r {
699	my ($self) = @_;	1057	my ($self) = @_;
700		1058
		1059	if (@_ > 1)
		1060	{
		1061	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1062	for $self->{beg} .. $self->{end};
		1063	}
		1064
		1065	if (defined wantarray) {
701	my $rend = [	1066	my $rend = [
702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1067	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
703	];	1068	];
704	$#$rend = $self->{len} - 1;	1069	$#$rend = $self->{len} - 1;
705	$rend	1070	return $rend;
		1071	}
		1072
		1073	()
706	}	1074	}
707		1075
708	sub urxvt::line::beg { $_[0]{beg} }	1076	sub urxvt::line::beg { $_[0]{beg} }
709	sub urxvt::line::end { $_[0]{end} }	1077	sub urxvt::line::end { $_[0]{end} }
710	sub urxvt::line::l { $_[0]{len} }	1078	sub urxvt::line::l { $_[0]{len} }
711		1079
712	sub urxvt::line::offset_of {	1080	sub urxvt::line::offset_of {
713	my ($self, $row, $col) = @_;	1081	my ($self, $row, $col) = @_;
714		1082
715	($row - $self->{beg}) * $self->{term}->ncol + $col	1083	($row - $self->{beg}) * $self->{ncol} + $col
716	}	1084	}
717		1085
718	sub urxvt::line::coord_of {	1086	sub urxvt::line::coord_of {
719	my ($self, $offset) = @_;	1087	my ($self, $offset) = @_;
720		1088
721	use integer;	1089	use integer;
722		1090
723	(	1091	(
724	$offset / $self->{term}->ncol + $self->{beg},	1092	$offset / $self->{ncol} + $self->{beg},
725	$offset % $self->{term}->ncol	1093	$offset % $self->{ncol}
726	)	1094	)
727	}	1095	}
728		1096
729	=item ($row, $col) = $line->coord_of ($offset)	1097	=item ($row, $col) = $line->coord_of ($offset)
730	=item $text = $term->special_encode $string	1098	=item $text = $term->special_encode $string
…		…
737		1105
738	Converts rxvt-unicodes text reprsentation into a perl string. See	1106	Converts rxvt-unicodes text reprsentation into a perl string. See
739	C<< $term->ROW_t >> for details.	1107	C<< $term->ROW_t >> for details.
740		1108
741	=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	}
742		1193
743	=head2 The C<urxvt::timer> Class	1194	=head2 The C<urxvt::timer> Class
744		1195
745	This class implements timer watchers/events. Time is represented as a	1196	This class implements timer watchers/events. Time is represented as a
746	fractional number of seconds since the epoch. Example:	1197	fractional number of seconds since the epoch. Example:
…		…
848	This variable controls the verbosity level of the perl extension. Higher	1299	This variable controls the verbosity level of the perl extension. Higher
849	numbers indicate more verbose output.	1300	numbers indicate more verbose output.
850		1301
851	=over 4	1302	=over 4
852		1303
853	=item 0 - only fatal messages	1304	=item == 0 - fatal messages
854		1305
855	=item 3 - script loading and management	1306	=item >= 3 - script loading and management
856		1307
857	=item 10 - all events received	1308	=item >=10 - all events received
858		1309
859	=back	1310	=back
860		1311
861	=head1 AUTHOR	1312	=head1 AUTHOR
862		1313

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.25 by root, Tue Jan 3 21:08:39 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.25 by root, Tue Jan 3 21:08:39 2006 UTC vs.
Revision 1.58 by root, Sun Jan 8 22:58:13 2006 UTC