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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.23 by root, Tue Jan 3 19:42:53 2006 UTC vs.
Revision 1.61 by root, Mon Jan 9 01:36:56 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-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
59	=item digital-clock	71	=item digital-clock
60		72
61	Displays a digital clock using the built-in overlay.	73	Displays a digital clock using the built-in overlay.
		74
		75	=item mark-urls
		76
		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.
62		84
63	=item example-refresh-hooks	85	=item example-refresh-hooks
64		86
65	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
66	window. Illustrates overwriting the refresh callbacks to create your own	88	window. Illustrates overwriting the refresh callbacks to create your own
…		…
79	When objects are destroyed on the C++ side, the perl object hashes are	101	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	102	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	103	the like inside the terminal object so they get destroyed as soon as the
82	terminal is destroyed.	104	terminal is destroyed.
83		105
		106	Argument names also often indicate the type of a parameter. Here are some
		107	hints on what they mean:
		108
		109	=over 4
		110
		111	=item $text
		112
		113	Rxvt-unicodes special way of encoding text, where one "unicode" character
		114	always represents one screen cell. See L<row_t> for a discussion of this format.
		115
		116	=item $string
		117
		118	A perl text string, with an emphasis on I<text>. It can store all unicode
		119	characters and is to be distinguished with text encoded in a specific
		120	encoding (often locale-specific) and binary data.
		121
		122	=item $octets
		123
		124	Either binary data or - more common - a text string encoded in a
		125	locale-specific way.
		126
		127	=back
		128
84	=head2 Hooks	129	=head2 Hooks
85		130
86	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
87	called whenever the relevant event happens.	132	called whenever the relevant event happens.
88		133
89	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
90	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
91	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>
92	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>
93	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.
94		140
95	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
96	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,
97	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.
98		144
…		…
101	=over 4	147	=over 4
102		148
103	=item on_init $term	149	=item on_init $term
104		150
105	Called after a new terminal object has been initialized, but before	151	Called after a new terminal object has been initialized, but before
106	windows are created or the command gets run.	152	windows are created or the command gets run. Most methods are unsafe to
		153	call or deliver senseless data, as terminal size and other characteristics
		154	have not yet been determined. You can safely query and change resources,
		155	though.
107		156
108	=item on_reset $term	157	=item on_reset $term
109		158
110	Called after the screen is "reset" for any reason, such as resizing or	159	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	160	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	189	should extend the selection itelf and return true to suppress the built-in
141	processing.	190	processing.
142		191
143	See the F<selection> example extension.	192	See the F<selection> example extension.
144		193
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	194	=item on_view_change $term, $offset
156		195
157	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
158	scrolls. Offset C<0> means display the normal terminal, positive values	197	scrolls. Offset C<0> means display the normal terminal, positive values
159	show this many lines of scrollback.	198	show this many lines of scrollback.
…		…
166		205
167	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,
168	$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
169	number of lines that will be in the scrollback buffer.	208	number of lines that will be in the scrollback buffer.
170		209
171	=item on_tty_activity $term NYI	210	=item on_osc_seq $term, $string
172		211
173	Called whenever the program(s) running in the urxvt window send output.	212	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		213	operating system command) is processed. Cursor position and other state
		214	information is up-to-date when this happens. For interoperability, the
		215	string should start with the extension name and a colon, to distinguish
		216	it from commands for other extensions, and this might be enforced in the
		217	future.
		218
		219	Be careful not ever to trust (in a security sense) the data you receive,
		220	as its source can not easily be controleld (e-mail content, messages from
		221	other users on the same system etc.).
		222
		223	=item on_add_lines $term, $string
		224
		225	Called whenever text is about to be output, with the text as argument. You
		226	can filter/change and output the text yourself by returning a true value
		227	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		228	might be very slow, however, as your hook is called for B<all> text being
		229	output.
		230
		231	=item on_line_update $term, $row
		232
		233	Called whenever a line was updated or changed. Can be used to filter
		234	screen output (e.g. underline urls or other useless stuff). Only lines
		235	that are being shown will be filtered, and, due to performance reasons,
		236	not always immediately.
		237
		238	The row number is always the topmost row of the line if the line spans
		239	multiple rows.
		240
		241	Please note that, if you change the line, then the hook might get called
		242	later with the already-modified line (e.g. if unrelated parts change), so
		243	you cannot just toggle rendition bits, but only set them.
174		244
175	=item on_refresh_begin $term	245	=item on_refresh_begin $term
176		246
177	Called just before the screen gets redrawn. Can be used for overlay	247	Called just before the screen gets redrawn. Can be used for overlay
178	or similar effects by modify terminal contents in refresh_begin, and	248	or similar effects by modify terminal contents in refresh_begin, and
…		…
187		257
188	Called whenever the user presses a key combination that has a	258	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>	259	C<perl:string> action bound to it (see description of the B<keysym>
190	resource in the @@RXVT_NAME@@(1) manpage).	260	resource in the @@RXVT_NAME@@(1) manpage).
191		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
192	=back	298	=back
193		299
194	=head2 Variables in the C<urxvt> Package	300	=head2 Variables in the C<urxvt> Package
195		301
196	=over 4	302	=over 4
197		303
198	=item $urxvt::TERM	304	=item $urxvt::TERM
199		305
200	The current terminal. Whenever a callback/Hook is bein executed, this	306	The current terminal. This variable stores the current C<urxvt::term>
201	variable stores the current C<urxvt::term> object.	307	object, whenever a callback/hook is executing.
202		308
203	=back	309	=back
204		310
205	=head2 Functions in the C<urxvt> Package	311	=head2 Functions in the C<urxvt> Package
206		312
207	=over 4	313	=over 4
		314
		315	=item $term = new urxvt [arg...]
		316
		317	Creates a new terminal, very similar as if you had started it with
		318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		319	if the new instance couldn't be created. Returns C<undef> if the new
		320	instance didn't initialise perl, and the terminal object otherwise. The
		321	C<init> and C<start> hooks will be called during the call.
208		322
209	=item urxvt::fatal $errormessage	323	=item urxvt::fatal $errormessage
210		324
211	Fatally aborts execution with the given error message. Avoid at all	325	Fatally aborts execution with the given error message. Avoid at all
212	costs! The only time this is acceptable is when the terminal process	326	costs! The only time this is acceptable is when the terminal process
…		…
222	correct place, e.g. on stderr of the connecting urxvtc client.	336	correct place, e.g. on stderr of the connecting urxvtc client.
223		337
224	=item $time = urxvt::NOW	338	=item $time = urxvt::NOW
225		339
226	Returns the "current time" (as per the event loop).	340	Returns the "current time" (as per the event loop).
		341
		342	=item urxvt::CurrentTime
		343
		344	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		345	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		346	Button4Mask, Button5Mask, AnyModifier
		347
		348	Various constants for use in X calls and event processing.
227		349
228	=back	350	=back
229		351
230	=head2 RENDITION	352	=head2 RENDITION
231		353
…		…
281		403
282	=cut	404	=cut
283		405
284	package urxvt;	406	package urxvt;
285		407
		408	use utf8;
286	use strict;	409	use strict;
287	use Scalar::Util ();	410	use Scalar::Util ();
		411	use List::Util ();
288		412
		413	our $VERSION = 1;
289	our $TERM;	414	our $TERM;
290	our @HOOKNAME;	415	our @HOOKNAME;
		416	our %OPTION;
291	our $LIBDIR;	417	our $LIBDIR;
292		418
293	BEGIN {	419	BEGIN {
294	urxvt->bootstrap;	420	urxvt->bootstrap;
295		421
…		…
298	my $msg = join "", @_;	424	my $msg = join "", @_;
299	$msg .= "\n"	425	$msg .= "\n"
300	unless $msg =~ /\n$/;	426	unless $msg =~ /\n$/;
301	urxvt::warn ($msg);	427	urxvt::warn ($msg);
302	};	428	};
		429
		430	delete $ENV{IFS};
		431	delete $ENV{CDPATH};
		432	delete $ENV{BASH_ENV};
		433	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
303	}	434	}
304		435
305	my @hook_count;	436	my @hook_count;
306	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	437	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
307		438
…		…
325	$hook_count[$htype]++	456	$hook_count[$htype]++
326	or set_should_invoke $htype, 1;	457	or set_should_invoke $htype, 1;
327	}	458	}
328	}	459	}
329		460
330	my $script_pkg = "script0000";	461	my $extension_pkg = "extension0000";
331	my %script_pkg;	462	my %extension_pkg;
332		463
333	# load a single script into its own package, once only	464	# load a single script into its own package, once only
334	sub script_package($) {	465	sub extension_package($) {
335	my ($path) = @_;	466	my ($path) = @_;
336		467
337	$script_pkg{$path} \|\|= do {	468	$extension_pkg{$path} \|\|= do {
338	my $pkg = "urxvt::" . ($script_pkg++);	469	my $pkg = "urxvt::" . ($extension_pkg++);
339		470
340	verbose 3, "loading script '$path' into package '$pkg'";	471	verbose 3, "loading extension '$path' into package '$pkg'";
341		472
342	open my $fh, "<:raw", $path	473	open my $fh, "<:raw", $path
343	or die "$path: $!";	474	or die "$path: $!";
344		475
345	my $source = "package $pkg; use strict; use utf8;\n"	476	my $source = untaint "package $pkg; use strict; use utf8;\n"
		477	. "use base urxvt::term::proxy::;\n"
346	. "#line 1 \"$path\"\n{\n"	478	. "#line 1 \"$path\"\n{\n"
347	. (do { local $/; <$fh> })	479	. (do { local $/; <$fh> })
348	. "\n};\n1";	480	. "\n};\n1";
349		481
350	eval $source or die "$path: $@";	482	eval $source or die "$path: $@";
351		483
352	$pkg	484	$pkg
353	}	485	}
354	}	486	}
		487
		488	our $retval; # return value for urxvt
355		489
356	# called by the rxvt core	490	# called by the rxvt core
357	sub invoke {	491	sub invoke {
358	local $TERM = shift;	492	local $TERM = shift;
359	my $htype = shift;	493	my $htype = shift;
360		494
361	if ($htype == 0) { # INIT	495	if ($htype == 0) { # INIT
362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	496	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		497
		498	my %want_ext;
363		499
364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	500	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		501	if ($_ eq "default") {
		502	$want_ext{$_}++ for qw(selection option-popup selection-popup);
		503	} elsif (/^-(.*)$/) {
		504	delete $want_ext{$1};
		505	} else {
		506	$want_ext{$_}++;
		507	}
		508	}
		509
		510	for my $ext (keys %want_ext) {
365	my @files = grep -f $_, map "$_/$ext", @dirs;	511	my @files = grep -f $_, map "$_/$ext", @dirs;
366		512
367	if (@files) {	513	if (@files) {
368	register_package script_package $files[0];	514	register_package extension_package $files[0];
369	} else {	515	} else {
370	warn "perl extension '$ext' not found in perl library search path\n";	516	warn "perl extension '$ext' not found in perl library search path\n";
371	}	517	}
372	}	518	}
373		519
		520	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		521	warn $@ if $@;
		522	}
		523
		524	$retval = undef;
		525
		526	if (my $cb = $TERM->{_hook}[$htype]) {
		527	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		528	if $verbosity >= 10;
		529
		530	keys %$cb;
		531
		532	while (my ($pkg, $cb) = each %$cb) {
		533	eval {
		534	$retval = $cb->(
		535	$TERM->{_pkg}{$pkg} \|\|= do {
		536	my $proxy = bless { }, $pkg;
		537	Scalar::Util::weaken ($proxy->{term} = $TERM);
		538	$proxy
		539	},
		540	@_,
		541	) and last;
		542	};
		543	if ($@) {
		544	$TERM->ungrab; # better to lose the grab than the session
		545	warn $@;
		546	}
		547	}
		548	}
		549
374	} elsif ($htype == 1) { # DESTROY	550	if ($htype == 1) { # DESTROY
		551	# remove hooks if unused
375	if (my $hook = $TERM->{_hook}) {	552	if (my $hook = $TERM->{_hook}) {
376	for my $htype (0..$#$hook) {	553	for my $htype (0..$#$hook) {
377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	554	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
378	or set_should_invoke $htype, 0;	555	or set_should_invoke $htype, 0;
379	}	556	}
380	}	557	}
		558
		559	# clear package objects
		560	%$_ = () for values %{ $TERM->{_pkg} };
		561
		562	# clear package
		563	%$TERM = ();
381	}	564	}
382		565
383	my $cb = $TERM->{_hook}[$htype]	566	$retval
384	or return;
385
386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
387	if $verbosity >= 10;
388
389	while (my ($pkg, $cb) = each %$cb) {
390	return 1
391	if $cb->(
392	$TERM->{$pkg} \|\|= do {
393	my $proxy = bless { }, urxvt::term::proxy::;
394	Scalar::Util::weaken ($proxy->{term} = $TERM);
395	$proxy
396	},
397	@_,
398	);
399	}
400
401	0
402	}	567	}
		568
		569	# urxvt::term::proxy
403		570
404	sub urxvt::term::proxy::AUTOLOAD {	571	sub urxvt::term::proxy::AUTOLOAD {
405	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	572	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
406	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	573	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
407		574
408	eval qq{	575	eval qq{
409	sub $urxvt::term::proxy::AUTOLOAD {	576	sub $urxvt::term::proxy::AUTOLOAD {
410	unshift \@_, shift->{term};	577	my \$proxy = shift;
411	goto &urxvt::term::$1;	578	\$proxy->{term}->$1 (\@_)
412	}	579	}
413	1	580	1
414	} or die "FATAL: unable to compile method forwarder: $@";	581	} or die "FATAL: unable to compile method forwarder: $@";
415		582
416	goto &$urxvt::term::proxy::AUTOLOAD;	583	goto &$urxvt::term::proxy::AUTOLOAD;
417	}	584	}
418		585
		586	sub urxvt::term::proxy::DESTROY {
		587	# nop
		588	}
		589
		590	# urxvt::destroy_hook
		591
		592	sub urxvt::destroy_hook::DESTROY {
		593	${$_[0]}->();
		594	}
		595
		596	sub urxvt::destroy_hook(&) {
		597	bless \shift, urxvt::destroy_hook::
		598	}
		599
		600	package urxvt::anyevent;
		601
		602	=head2 The C<urxvt::anyevent> Class
		603
		604	The sole purpose of this class is to deliver an interface to the
		605	C<AnyEvent> module - any module using it will work inside urxvt without
		606	further work. The only exception is that you cannot wait on condition
		607	variables, but non-blocking condvar use is ok. What this means is that you
		608	cannot use blocking APIs, but the non-blocking variant should work.
		609
		610	=cut
		611
		612	our $VERSION = 1;
		613
		614	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		615	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		616
		617	sub timer {
		618	my ($class, %arg) = @_;
		619
		620	my $cb = $arg{cb};
		621
		622	urxvt::timer
		623	->new
		624	->start (urxvt::NOW + $arg{after})
		625	->cb (sub {
		626	$_[0]->stop; # need to cancel manually
		627	$cb->();
		628	})
		629	}
		630
		631	sub io {
		632	my ($class, %arg) = @_;
		633
		634	my $cb = $arg{cb};
		635
		636	bless [$arg{fh}, urxvt::iow
		637	->new
		638	->fd (fileno $arg{fh})
		639	->events (($arg{poll} =~ /r/ ? 1 : 0)
		640	\| ($arg{poll} =~ /w/ ? 2 : 0))
		641	->start
		642	->cb (sub {
		643	$cb->(($_[1] & 1 ? 'r' : '')
		644	. ($_[1] & 2 ? 'w' : ''));
		645	})],
		646	urxvt::anyevent::
		647	}
		648
		649	sub DESTROY {
		650	$_[0][1]->stop;
		651	}
		652
		653	sub condvar {
		654	bless \my $flag, urxvt::anyevent::condvar::
		655	}
		656
		657	sub urxvt::anyevent::condvar::broadcast {
		658	${$_[0]}++;
		659	}
		660
		661	sub urxvt::anyevent::condvar::wait {
		662	unless (${$_[0]}) {
		663	require Carp;
		664	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		665	}
		666	}
		667
		668	package urxvt::term;
		669
419	=head2 The C<urxvt::term> Class	670	=head2 The C<urxvt::term> Class
420		671
421	=over 4	672	=over 4
		673
		674	=item $term->destroy
		675
		676	Destroy the terminal object (close the window, free resources etc.).
		677
		678	=item $isset = $term->option ($optval[, $set])
		679
		680	Returns true if the option specified by C<$optval> is enabled, and
		681	optionally change it. All option values are stored by name in the hash
		682	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		683
		684	Here is a a likely non-exhaustive list of option names, please see the
		685	source file F</src/optinc.h> to see the actual list:
		686
		687	borderLess console cursorBlink cursorUnderline hold iconic insecure
		688	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		689	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		690	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		691	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		692	tripleclickwords utmpInhibit visualBell
422		693
423	=item $value = $term->resource ($name[, $newval])	694	=item $value = $term->resource ($name[, $newval])
424		695
425	Returns the current resource value associated with a given name and	696	Returns the current resource value associated with a given name and
426	optionally sets a new value. Setting values is most useful in the C<init>	697	optionally sets a new value. Setting values is most useful in the C<init>
…		…
436		707
437	Please note that resource strings will currently only be freed when the	708	Please note that resource strings will currently only be freed when the
438	terminal is destroyed, so changing options frequently will eat memory.	709	terminal is destroyed, so changing options frequently will eat memory.
439		710
440	Here is a a likely non-exhaustive list of resource names, not all of which	711	Here is a a likely non-exhaustive list of resource names, not all of which
441	are supported in every build, please see the source to see the actual	712	are supported in every build, please see the source file F</src/rsinc.h>
442	list:	713	to see the actual list:
443		714
444	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	715	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
445	borderLess color cursorBlink cursorUnderline cutchars delete_key	716	borderLess color cursorBlink cursorUnderline cutchars delete_key
446	display_name embed ext_bwidth fade font geometry hold iconName	717	display_name embed ext_bwidth fade font geometry hold iconName
447	imFont imLocale inputMethod insecure int_bwidth intensityStyles	718	imFont imLocale inputMethod insecure int_bwidth intensityStyles
448	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	719	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
449	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	720	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
450	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	721	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
451	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	722	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
452	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	723	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
453	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	724	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
454	shade term_name title transparent transparent_all tripleclickwords	725	shade term_name title transparent transparent_all tripleclickwords
455	utmpInhibit visualBell	726	utmpInhibit visualBell
456		727
457	=cut	728	=cut
458		729
459	sub urxvt::term::resource($$;$) {	730	sub resource($$;$) {
460	my ($self, $name) = (shift, shift);	731	my ($self, $name) = (shift, shift);
461	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	732	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
462	goto &urxvt::term::_resource;	733	&urxvt::term::_resource
463	}	734	}
		735
		736	=item $rend = $term->rstyle ([$new_rstyle])
		737
		738	Return and optionally change the current rendition. Text that is output by
		739	the terminal application will use this style.
		740
		741	=item ($row, $col) = $term->screen_cur ([$row, $col])
		742
		743	Return the current coordinates of the text cursor position and optionally
		744	set it (which is usually bad as applications don't expect that).
464		745
465	=item ($row, $col) = $term->selection_mark ([$row, $col])	746	=item ($row, $col) = $term->selection_mark ([$row, $col])
466		747
467	=item ($row, $col) = $term->selection_beg ([$row, $col])	748	=item ($row, $col) = $term->selection_beg ([$row, $col])
468		749
…		…
483	#=item $term->overlay ($x, $y, $text)	764	#=item $term->overlay ($x, $y, $text)
484	#	765	#
485	#Create a simple multi-line overlay box. See the next method for details.	766	#Create a simple multi-line overlay box. See the next method for details.
486	#	767	#
487	#=cut	768	#=cut
488		769	#
489	sub urxvt::term::scr_overlay {	770	#sub urxvt::term::scr_overlay {
490	die;
491	my ($self, $x, $y, $text) = @_;	771	# my ($self, $x, $y, $text) = @_;
492		772	#
493	my @lines = split /\n/, $text;	773	# my @lines = split /\n/, $text;
494		774	#
495	my $w = 0;	775	# my $w = 0;
496	for (map $self->strwidth ($_), @lines) {	776	# for (map $self->strwidth ($_), @lines) {
497	$w = $_ if $w < $_;	777	# $w = $_ if $w < $_;
498	}	778	# }
499		779	#
500	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	780	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
501	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	781	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
502	}	782	#}
503		783
504	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	784	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
505		785
506	Create a new (empty) overlay at the given position with the given	786	Create a new (empty) overlay at the given position with the given
507	width/height. C<$rstyle> defines the initial rendition style	787	width/height. C<$rstyle> defines the initial rendition style
…		…
534		814
535	If hidden, display the overlay again.	815	If hidden, display the overlay again.
536		816
537	=back	817	=back
538		818
		819	=item $popup = $term->popup ($event)
		820
		821	Creates a new C<urxvt::popup> object that implements a popup menu. The
		822	C<$event> I<must> be the event causing the menu to pop up (a button event,
		823	currently).
		824
		825	=cut
		826
		827	sub popup {
		828	my ($self, $event) = @_;
		829
		830	$self->grab ($event->{time}, 1)
		831	or return;
		832
		833	my $popup = bless {
		834	term => $self,
		835	event => $event,
		836	}, urxvt::popup::;
		837
		838	Scalar::Util::weaken $popup->{term};
		839
		840	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		841	Scalar::Util::weaken $self->{_destroy}{$popup};
		842
		843	$popup
		844	}
		845
539	=item $cellwidth = $term->strwidth $string	846	=item $cellwidth = $term->strwidth ($string)
540		847
541	Returns the number of screen-cells this string would need. Correctly	848	Returns the number of screen-cells this string would need. Correctly
542	accounts for wide and combining characters.	849	accounts for wide and combining characters.
543		850
544	=item $octets = $term->locale_encode $string	851	=item $octets = $term->locale_encode ($string)
545		852
546	Convert the given text string into the corresponding locale encoding.	853	Convert the given text string into the corresponding locale encoding.
547		854
548	=item $string = $term->locale_decode $octets	855	=item $string = $term->locale_decode ($octets)
549		856
550	Convert the given locale-encoded octets into a perl string.	857	Convert the given locale-encoded octets into a perl string.
		858
		859	=item $term->scr_add_lines ($string)
		860
		861	Write the given text string to the screen, as if output by the application
		862	running inside the terminal. It may not contain command sequences (escape
		863	codes), but is free to use line feeds, carriage returns and tabs. The
		864	string is a normal text string, not in locale-dependent encoding.
		865
		866	Normally its not a good idea to use this function, as programs might be
		867	confused by changes in cursor position or scrolling. Its useful inside a
		868	C<on_add_lines> hook, though.
		869
		870	=item $term->cmd_parse ($octets)
		871
		872	Similar to C<scr_add_lines>, but the argument must be in the
		873	locale-specific encoding of the terminal and can contain command sequences
		874	(escape codes) that will be interpreted.
551		875
552	=item $term->tt_write ($octets)	876	=item $term->tt_write ($octets)
553		877
554	Write the octets given in C<$data> to the tty (i.e. as program input). To	878	Write the octets given in C<$data> to the tty (i.e. as program input). To
555	pass characters instead of octets, you should convert your strings first	879	pass characters instead of octets, you should convert your strings first
556	to the locale-specific encoding using C<< $term->locale_encode >>.	880	to the locale-specific encoding using C<< $term->locale_encode >>.
557		881
		882	=item $windowid = $term->parent
		883
		884	Return the window id of the toplevel window.
		885
		886	=item $windowid = $term->vt
		887
		888	Return the window id of the terminal window.
		889
		890	=item $window_width = $term->width
		891
		892	=item $window_height = $term->height
		893
		894	=item $font_width = $term->fwidth
		895
		896	=item $font_height = $term->fheight
		897
		898	=item $font_ascent = $term->fbase
		899
558	=item $nrow = $term->nrow	900	=item $terminal_rows = $term->nrow
559		901
560	=item $ncol = $term->ncol	902	=item $terminal_columns = $term->ncol
561		903
562	Return the number of rows/columns of the terminal window (i.e. as	904	=item $has_focus = $term->focus
563	specified by C<-geometry>, excluding any scrollback).
564		905
565	=item $nsaved = $term->nsaved	906	=item $is_mapped = $term->mapped
566		907
567	Returns the number of lines in the scrollback buffer.	908	=item $max_scrollback = $term->saveLines
		909
		910	=item $nrow_plus_saveLines = $term->total_rows
		911
		912	=item $lines_in_scrollback = $term->nsaved
		913
		914	Return various integers describing terminal characteristics.
		915
		916	=item $modifiermask = $term->ModLevel3Mask
		917
		918	=item $modifiermask = $term->ModMetaMask
		919
		920	=item $modifiermask = $term->ModNumLockMask
		921
		922	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		923	AltGr), the meta key (often Alt) and the num lock key, if applicable.
568		924
569	=item $view_start = $term->view_start ([$newvalue])	925	=item $view_start = $term->view_start ([$newvalue])
570		926
571	Returns the negative row number of the topmost line. Minimum value is	927	Returns the negative row number of the topmost line. Minimum value is
572	C<0>, which displays the normal terminal contents. Larger values scroll	928	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
583	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	939	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
584		940
585	Returns the text of the entire row with number C<$row_number>. Row C<0>	941	Returns the text of the entire row with number C<$row_number>. Row C<0>
586	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	942	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
587	terminal line. The scrollback buffer starts at line C<-1> and extends to	943	terminal line. The scrollback buffer starts at line C<-1> and extends to
588	line C<< -$term->nsaved >>.	944	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		945	is requested.
589		946
590	If C<$new_text> is specified, it will replace characters in the current	947	If C<$new_text> is specified, it will replace characters in the current
591	line, starting at column C<$start_col> (default C<0>), which is useful	948	line, starting at column C<$start_col> (default C<0>), which is useful
592	to replace only parts of a line. The font index in the rendition will	949	to replace only parts of a line. The font index in the rendition will
593	automatically be updated.	950	automatically be updated.
…		…
615		972
616	See the section on RENDITION, above.	973	See the section on RENDITION, above.
617		974
618	=item $length = $term->ROW_l ($row_number[, $new_length])	975	=item $length = $term->ROW_l ($row_number[, $new_length])
619		976
620	Returns the number of screen cells that are in use ("the line length"). If	977	Returns the number of screen cells that are in use ("the line
621	it is C<-1>, then the line is part of a multiple-row logical "line", which	978	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
622	means all characters are in use and it is continued on the next row.	979	line is joined with the following one.
		980
		981	=item $bool = $term->is_longer ($row_number)
		982
		983	Returns true if the row is part of a multiple-row logical "line" (i.e.
		984	joined with the following row), which means all characters are in use
		985	and it is continued on the next row (and possibly a continuation of the
		986	previous row(s)).
		987
		988	=item $line = $term->line ($row_number)
		989
		990	Create and return a new C<urxvt::line> object that stores information
		991	about the logical line that row C<$row_number> is part of. It supports the
		992	following methods:
		993
		994	=over 4
		995
		996	=item $text = $line->t ([$new_text])
		997
		998	Returns or replaces the full text of the line, similar to C<ROW_t>
		999
		1000	=item $rend = $line->r ([$new_rend])
		1001
		1002	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		1003
		1004	=item $length = $line->l
		1005
		1006	Returns the length of the line in cells, similar to C<ROW_l>.
		1007
		1008	=item $rownum = $line->beg
		1009
		1010	=item $rownum = $line->end
		1011
		1012	Return the row number of the first/last row of the line, respectively.
		1013
		1014	=item $offset = $line->offset_of ($row, $col)
		1015
		1016	Returns the character offset of the given row\|col pair within the logical
		1017	line.
		1018
		1019	=item ($row, $col) = $line->coord_of ($offset)
		1020
		1021	Translates a string offset into terminal coordinates again.
		1022
		1023	=back
		1024
		1025	=cut
		1026
		1027	sub line {
		1028	my ($self, $row) = @_;
		1029
		1030	my $maxrow = $self->nrow - 1;
		1031
		1032	my ($beg, $end) = ($row, $row);
		1033
		1034	--$beg while $self->ROW_is_longer ($beg - 1);
		1035	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1036
		1037	bless {
		1038	term => $self,
		1039	beg => $beg,
		1040	end => $end,
		1041	ncol => $self->ncol,
		1042	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1043	}, urxvt::line::
		1044	}
		1045
		1046	sub urxvt::line::t {
		1047	my ($self) = @_;
		1048
		1049	if (@_ > 1)
		1050	{
		1051	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1052	for $self->{beg} .. $self->{end};
		1053	}
		1054
		1055	defined wantarray &&
		1056	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1057	0, $self->{len}
		1058	}
		1059
		1060	sub urxvt::line::r {
		1061	my ($self) = @_;
		1062
		1063	if (@_ > 1)
		1064	{
		1065	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1066	for $self->{beg} .. $self->{end};
		1067	}
		1068
		1069	if (defined wantarray) {
		1070	my $rend = [
		1071	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1072	];
		1073	$#$rend = $self->{len} - 1;
		1074	return $rend;
		1075	}
		1076
		1077	()
		1078	}
		1079
		1080	sub urxvt::line::beg { $_[0]{beg} }
		1081	sub urxvt::line::end { $_[0]{end} }
		1082	sub urxvt::line::l { $_[0]{len} }
		1083
		1084	sub urxvt::line::offset_of {
		1085	my ($self, $row, $col) = @_;
		1086
		1087	($row - $self->{beg}) * $self->{ncol} + $col
		1088	}
		1089
		1090	sub urxvt::line::coord_of {
		1091	my ($self, $offset) = @_;
		1092
		1093	use integer;
		1094
		1095	(
		1096	$offset / $self->{ncol} + $self->{beg},
		1097	$offset % $self->{ncol}
		1098	)
		1099	}
623		1100
624	=item $text = $term->special_encode $string	1101	=item $text = $term->special_encode $string
625		1102
626	Converts a perl string into the special encoding used by rxvt-unicode,	1103	Converts a perl string into the special encoding used by rxvt-unicode,
627	where one character corresponds to one screen cell. See	1104	where one character corresponds to one screen cell. See
…		…
630	=item $string = $term->special_decode $text	1107	=item $string = $term->special_decode $text
631		1108
632	Converts rxvt-unicodes text reprsentation into a perl string. See	1109	Converts rxvt-unicodes text reprsentation into a perl string. See
633	C<< $term->ROW_t >> for details.	1110	C<< $term->ROW_t >> for details.
634		1111
		1112	=item $success = $term->grab_button ($button, $modifiermask)
		1113
		1114	Registers a synchronous button grab. See XGrabButton.
		1115
		1116	=item $success = $term->grab ($eventtime[, $sync])
		1117
		1118	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1119	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1120
		1121	=item $term->allow_events_async
		1122
		1123	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1124
		1125	=item $term->allow_events_sync
		1126
		1127	Calls XAllowEvents with SyncBoth for the most recent grab.
		1128
		1129	=item $term->allow_events_replay
		1130
		1131	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1132	recent grab.
		1133
		1134	=item $term->ungrab
		1135
		1136	Calls XUngrab for the most recent grab. Is called automatically on
		1137	evaluation errors, as it is better to lose the grab in the error case as
		1138	the session.
		1139
635	=back	1140	=back
		1141
		1142	=cut
		1143
		1144	package urxvt::popup;
		1145
		1146	=head2 The C<urxvt::popup> Class
		1147
		1148	=over 4
		1149
		1150	=cut
		1151
		1152	sub add_item {
		1153	my ($self, $item) = @_;
		1154
		1155	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1156	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1157	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1158
		1159	$item->{render} \|\|= sub { $_[0]{text} };
		1160
		1161	push @{ $self->{item} }, $item;
		1162	}
		1163
		1164	sub add_separator {
		1165	my ($self, $sep) = @_;
		1166
		1167	$sep \|\|= "═";
		1168
		1169	$self->add_item ({
		1170	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1171	text => "",
		1172	render => sub { $sep x $urxvt::TERM->ncol },
		1173	activate => sub { },
		1174	});
		1175	}
		1176
		1177	sub add_title {
		1178	my ($self, $title) = @_;
		1179
		1180	$self->add_item ({
		1181	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1182	text => $title,
		1183	activate => sub { },
		1184	});
		1185	}
		1186
		1187	sub add_button {
		1188	my ($self, $text, $cb) = @_;
		1189
		1190	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1191	}
		1192
		1193	sub add_toggle {
		1194	my ($self, $text, $cb, $value) = @_;
		1195
		1196	my $item; $item = {
		1197	type => "button",
		1198	text => " $text",
		1199	value => $value,
		1200	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1201	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1202	};
		1203
		1204	$self->add_item ($item);
		1205	}
		1206
		1207	sub show {
		1208	my ($self) = @_;
		1209
		1210	local $urxvt::popup::self = $self;
		1211
		1212	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1213	"--transient-for" => $self->{term}->parent,
		1214	"-pe" => "urxvt-popup")
		1215	or die "unable to create popup window\n";
		1216	}
		1217
		1218	sub DESTROY {
		1219	my ($self) = @_;
		1220
		1221	delete $self->{term}{_destroy}{$self};
		1222	$self->{term}->ungrab;
		1223	}
636		1224
637	=head2 The C<urxvt::timer> Class	1225	=head2 The C<urxvt::timer> Class
638		1226
639	This class implements timer watchers/events. Time is represented as a	1227	This class implements timer watchers/events. Time is represented as a
640	fractional number of seconds since the epoch. Example:	1228	fractional number of seconds since the epoch. Example:
…		…
742	This variable controls the verbosity level of the perl extension. Higher	1330	This variable controls the verbosity level of the perl extension. Higher
743	numbers indicate more verbose output.	1331	numbers indicate more verbose output.
744		1332
745	=over 4	1333	=over 4
746		1334
747	=item 0 - only fatal messages	1335	=item == 0 - fatal messages
748		1336
749	=item 3 - script loading and management	1337	=item >= 3 - script loading and management
750		1338
751	=item 10 - all events received	1339	=item >=10 - all events received
752		1340
753	=back	1341	=back
754		1342
755	=head1 AUTHOR	1343	=head1 AUTHOR
756		1344

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.23 by root, Tue Jan 3 19:42:53 2006 UTC vs. Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.23 by root, Tue Jan 3 19:42:53 2006 UTC vs.
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC