[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.60 by root, Mon Jan 9 01:21:43 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.
…		…
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_tty_activity $term NYI
172		211
173	Called whenever the program(s) running in the urxvt window send output.	212	Called whenever the program(s) running in the urxvt window send output.
		213
		214	=item on_osc_seq $term, $string
		215
		216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		217	operating system command) is processed. Cursor position and other state
		218	information is up-to-date when this happens. For interoperability, the
		219	string should start with the extension name and a colon, to distinguish
		220	it from commands for other extensions, and this might be enforced in the
		221	future.
		222
		223	Be careful not ever to trust (in a security sense) the data you receive,
		224	as its source can not easily be controleld (e-mail content, messages from
		225	other users on the same system etc.).
		226
		227	=item on_add_lines $term, $string
		228
		229	Called whenever text is about to be output, with the text as argument. You
		230	can filter/change and output the text yourself by returning a true value
		231	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		232	might be very slow, however, as your hook is called for B<all> text being
		233	output.
		234
		235	=item on_line_update $term, $row
		236
		237	Called whenever a line was updated or changed. Can be used to filter
		238	screen output (e.g. underline urls or other useless stuff). Only lines
		239	that are being shown will be filtered, and, due to performance reasons,
		240	not always immediately.
		241
		242	The row number is always the topmost row of the line if the line spans
		243	multiple rows.
		244
		245	Please note that, if you change the line, then the hook might get called
		246	later with the already-modified line (e.g. if unrelated parts change), so
		247	you cannot just toggle rendition bits, but only set them.
174		248
175	=item on_refresh_begin $term	249	=item on_refresh_begin $term
176		250
177	Called just before the screen gets redrawn. Can be used for overlay	251	Called just before the screen gets redrawn. Can be used for overlay
178	or similar effects by modify terminal contents in refresh_begin, and	252	or similar effects by modify terminal contents in refresh_begin, and
…		…
187		261
188	Called whenever the user presses a key combination that has a	262	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>	263	C<perl:string> action bound to it (see description of the B<keysym>
190	resource in the @@RXVT_NAME@@(1) manpage).	264	resource in the @@RXVT_NAME@@(1) manpage).
191		265
		266	=item on_focus_in $term
		267
		268	Called whenever the window gets the keyboard focus, before rxvt-unicode
		269	does focus in processing.
		270
		271	=item on_focus_out $term
		272
		273	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		274	focus out processing.
		275
		276	=item on_key_press $term, $event, $octets
		277
		278	=item on_key_release $term, $event
		279
		280	=item on_button_press $term, $event
		281
		282	=item on_button_release $term, $event
		283
		284	=item on_motion_notify $term, $event
		285
		286	=item on_map_notify $term, $event
		287
		288	=item on_unmap_notify $term, $event
		289
		290	Called whenever the corresponding X event is received for the terminal If
		291	the hook returns true, then the even will be ignored by rxvt-unicode.
		292
		293	The event is a hash with most values as named by Xlib (see the XEvent
		294	manpage), with the additional members C<row> and C<col>, which are the row
		295	and column under the mouse cursor.
		296
		297	C<on_key_press> additionally receives the string rxvt-unicode would
		298	output, if any, in locale-specific encoding.
		299
		300	subwindow.
		301
192	=back	302	=back
193		303
194	=head2 Variables in the C<urxvt> Package	304	=head2 Variables in the C<urxvt> Package
195		305
196	=over 4	306	=over 4
197		307
198	=item $urxvt::TERM	308	=item $urxvt::TERM
199		309
200	The current terminal. Whenever a callback/Hook is bein executed, this	310	The current terminal. This variable stores the current C<urxvt::term>
201	variable stores the current C<urxvt::term> object.	311	object, whenever a callback/hook is executing.
202		312
203	=back	313	=back
204		314
205	=head2 Functions in the C<urxvt> Package	315	=head2 Functions in the C<urxvt> Package
206		316
207	=over 4	317	=over 4
		318
		319	=item $term = new urxvt [arg...]
		320
		321	Creates a new terminal, very similar as if you had started it with
		322	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		323	if the new instance couldn't be created. Returns C<undef> if the new
		324	instance didn't initialise perl, and the terminal object otherwise. The
		325	C<init> and C<start> hooks will be called during the call.
208		326
209	=item urxvt::fatal $errormessage	327	=item urxvt::fatal $errormessage
210		328
211	Fatally aborts execution with the given error message. Avoid at all	329	Fatally aborts execution with the given error message. Avoid at all
212	costs! The only time this is acceptable is when the terminal process	330	costs! The only time this is acceptable is when the terminal process
…		…
222	correct place, e.g. on stderr of the connecting urxvtc client.	340	correct place, e.g. on stderr of the connecting urxvtc client.
223		341
224	=item $time = urxvt::NOW	342	=item $time = urxvt::NOW
225		343
226	Returns the "current time" (as per the event loop).	344	Returns the "current time" (as per the event loop).
		345
		346	=item urxvt::CurrentTime
		347
		348	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		349	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		350	Button4Mask, Button5Mask, AnyModifier
		351
		352	Various constants for use in X calls and event processing.
227		353
228	=back	354	=back
229		355
230	=head2 RENDITION	356	=head2 RENDITION
231		357
…		…
281		407
282	=cut	408	=cut
283		409
284	package urxvt;	410	package urxvt;
285		411
		412	use utf8;
286	use strict;	413	use strict;
287	use Scalar::Util ();	414	use Scalar::Util ();
		415	use List::Util ();
288		416
		417	our $VERSION = 1;
289	our $TERM;	418	our $TERM;
290	our @HOOKNAME;	419	our @HOOKNAME;
		420	our %OPTION;
291	our $LIBDIR;	421	our $LIBDIR;
292		422
293	BEGIN {	423	BEGIN {
294	urxvt->bootstrap;	424	urxvt->bootstrap;
295		425
…		…
298	my $msg = join "", @_;	428	my $msg = join "", @_;
299	$msg .= "\n"	429	$msg .= "\n"
300	unless $msg =~ /\n$/;	430	unless $msg =~ /\n$/;
301	urxvt::warn ($msg);	431	urxvt::warn ($msg);
302	};	432	};
		433
		434	delete $ENV{IFS};
		435	delete $ENV{CDPATH};
		436	delete $ENV{BASH_ENV};
		437	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
303	}	438	}
304		439
305	my @hook_count;	440	my @hook_count;
306	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	441	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
307		442
…		…
325	$hook_count[$htype]++	460	$hook_count[$htype]++
326	or set_should_invoke $htype, 1;	461	or set_should_invoke $htype, 1;
327	}	462	}
328	}	463	}
329		464
330	my $script_pkg = "script0000";	465	my $extension_pkg = "extension0000";
331	my %script_pkg;	466	my %extension_pkg;
332		467
333	# load a single script into its own package, once only	468	# load a single script into its own package, once only
334	sub script_package($) {	469	sub extension_package($) {
335	my ($path) = @_;	470	my ($path) = @_;
336		471
337	$script_pkg{$path} \|\|= do {	472	$extension_pkg{$path} \|\|= do {
338	my $pkg = "urxvt::" . ($script_pkg++);	473	my $pkg = "urxvt::" . ($extension_pkg++);
339		474
340	verbose 3, "loading script '$path' into package '$pkg'";	475	verbose 3, "loading extension '$path' into package '$pkg'";
341		476
342	open my $fh, "<:raw", $path	477	open my $fh, "<:raw", $path
343	or die "$path: $!";	478	or die "$path: $!";
344		479
345	my $source = "package $pkg; use strict; use utf8;\n"	480	my $source = untaint "package $pkg; use strict; use utf8;\n"
		481	. "use base urxvt::term::proxy::;\n"
346	. "#line 1 \"$path\"\n{\n"	482	. "#line 1 \"$path\"\n{\n"
347	. (do { local $/; <$fh> })	483	. (do { local $/; <$fh> })
348	. "\n};\n1";	484	. "\n};\n1";
349		485
350	eval $source or die "$path: $@";	486	eval $source or die "$path: $@";
351		487
352	$pkg	488	$pkg
353	}	489	}
354	}	490	}
		491
		492	our $retval; # return value for urxvt
355		493
356	# called by the rxvt core	494	# called by the rxvt core
357	sub invoke {	495	sub invoke {
358	local $TERM = shift;	496	local $TERM = shift;
359	my $htype = shift;	497	my $htype = shift;
360		498
361	if ($htype == 0) { # INIT	499	if ($htype == 0) { # INIT
362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	500	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		501
		502	my %want_ext;
363		503
364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	504	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		505	if ($_ eq "default") {
		506	$want_ext{$_}++ for qw(selection option-popup selection-popup);
		507	} elsif (/^-(.*)$/) {
		508	delete $want_ext{$1};
		509	} else {
		510	$want_ext{$_}++;
		511	}
		512	}
		513
		514	for my $ext (keys %want_ext) {
365	my @files = grep -f $_, map "$_/$ext", @dirs;	515	my @files = grep -f $_, map "$_/$ext", @dirs;
366		516
367	if (@files) {	517	if (@files) {
368	register_package script_package $files[0];	518	register_package extension_package $files[0];
369	} else {	519	} else {
370	warn "perl extension '$ext' not found in perl library search path\n";	520	warn "perl extension '$ext' not found in perl library search path\n";
371	}	521	}
372	}	522	}
373		523
		524	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		525	warn $@ if $@;
		526	}
		527
		528	$retval = undef;
		529
		530	if (my $cb = $TERM->{_hook}[$htype]) {
		531	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		532	if $verbosity >= 10;
		533
		534	keys %$cb;
		535
		536	while (my ($pkg, $cb) = each %$cb) {
		537	eval {
		538	$retval = $cb->(
		539	$TERM->{_pkg}{$pkg} \|\|= do {
		540	my $proxy = bless { }, $pkg;
		541	Scalar::Util::weaken ($proxy->{term} = $TERM);
		542	$proxy
		543	},
		544	@_,
		545	) and last;
		546	};
		547	if ($@) {
		548	$TERM->ungrab; # better to lose the grab than the session
		549	warn $@;
		550	}
		551	}
		552	}
		553
374	} elsif ($htype == 1) { # DESTROY	554	if ($htype == 1) { # DESTROY
		555	# remove hooks if unused
375	if (my $hook = $TERM->{_hook}) {	556	if (my $hook = $TERM->{_hook}) {
376	for my $htype (0..$#$hook) {	557	for my $htype (0..$#$hook) {
377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	558	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
378	or set_should_invoke $htype, 0;	559	or set_should_invoke $htype, 0;
379	}	560	}
380	}	561	}
		562
		563	# clear package objects
		564	%$_ = () for values %{ $TERM->{_pkg} };
		565
		566	# clear package
		567	%$TERM = ();
381	}	568	}
382		569
383	my $cb = $TERM->{_hook}[$htype]	570	$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	}	571	}
		572
		573	# urxvt::term::proxy
405		574
406	sub urxvt::term::proxy::AUTOLOAD {	575	sub urxvt::term::proxy::AUTOLOAD {
407	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	576	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
408	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	577	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
409		578
…		…
416	} or die "FATAL: unable to compile method forwarder: $@";	585	} or die "FATAL: unable to compile method forwarder: $@";
417		586
418	goto &$urxvt::term::proxy::AUTOLOAD;	587	goto &$urxvt::term::proxy::AUTOLOAD;
419	}	588	}
420		589
		590	sub urxvt::term::proxy::DESTROY {
		591	# nop
		592	}
		593
		594	# urxvt::destroy_hook
		595
		596	sub urxvt::destroy_hook::DESTROY {
		597	${$_[0]}->();
		598	}
		599
		600	sub urxvt::destroy_hook(&) {
		601	bless \shift, urxvt::destroy_hook::
		602	}
		603
		604	package urxvt::anyevent;
		605
		606	=head2 The C<urxvt::anyevent> Class
		607
		608	The sole purpose of this class is to deliver an interface to the
		609	C<AnyEvent> module - any module using it will work inside urxvt without
		610	further work. The only exception is that you cannot wait on condition
		611	variables, but non-blocking condvar use is ok. What this means is that you
		612	cannot use blocking APIs, but the non-blocking variant should work.
		613
		614	=cut
		615
		616	our $VERSION = 1;
		617
		618	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		619	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		620
		621	sub timer {
		622	my ($class, %arg) = @_;
		623
		624	my $cb = $arg{cb};
		625
		626	urxvt::timer
		627	->new
		628	->start (urxvt::NOW + $arg{after})
		629	->cb (sub {
		630	$_[0]->stop; # need to cancel manually
		631	$cb->();
		632	})
		633	}
		634
		635	sub io {
		636	my ($class, %arg) = @_;
		637
		638	my $cb = $arg{cb};
		639
		640	bless [$arg{fh}, urxvt::iow
		641	->new
		642	->fd (fileno $arg{fh})
		643	->events (($arg{poll} =~ /r/ ? 1 : 0)
		644	\| ($arg{poll} =~ /w/ ? 2 : 0))
		645	->start
		646	->cb (sub {
		647	$cb->(($_[1] & 1 ? 'r' : '')
		648	. ($_[1] & 2 ? 'w' : ''));
		649	})],
		650	urxvt::anyevent::
		651	}
		652
		653	sub DESTROY {
		654	$_[0][1]->stop;
		655	}
		656
		657	sub condvar {
		658	bless \my $flag, urxvt::anyevent::condvar::
		659	}
		660
		661	sub urxvt::anyevent::condvar::broadcast {
		662	${$_[0]}++;
		663	}
		664
		665	sub urxvt::anyevent::condvar::wait {
		666	unless (${$_[0]}) {
		667	require Carp;
		668	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		669	}
		670	}
		671
		672	package urxvt::term;
		673
421	=head2 The C<urxvt::term> Class	674	=head2 The C<urxvt::term> Class
422		675
423	=over 4	676	=over 4
		677
		678	=item $term->destroy
		679
		680	Destroy the terminal object (close the window, free resources etc.).
		681
		682	=item $isset = $term->option ($optval[, $set])
		683
		684	Returns true if the option specified by C<$optval> is enabled, and
		685	optionally change it. All option values are stored by name in the hash
		686	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		687
		688	Here is a a likely non-exhaustive list of option names, please see the
		689	source file F</src/optinc.h> to see the actual list:
		690
		691	borderLess console cursorBlink cursorUnderline hold iconic insecure
		692	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		693	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		694	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		695	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		696	tripleclickwords utmpInhibit visualBell
424		697
425	=item $value = $term->resource ($name[, $newval])	698	=item $value = $term->resource ($name[, $newval])
426		699
427	Returns the current resource value associated with a given name and	700	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>	701	optionally sets a new value. Setting values is most useful in the C<init>
…		…
438		711
439	Please note that resource strings will currently only be freed when the	712	Please note that resource strings will currently only be freed when the
440	terminal is destroyed, so changing options frequently will eat memory.	713	terminal is destroyed, so changing options frequently will eat memory.
441		714
442	Here is a a likely non-exhaustive list of resource names, not all of which	715	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	716	are supported in every build, please see the source file F</src/rsinc.h>
444	list:	717	to see the actual list:
445		718
446	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	719	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447	borderLess color cursorBlink cursorUnderline cutchars delete_key	720	borderLess color cursorBlink cursorUnderline cutchars delete_key
448	display_name embed ext_bwidth fade font geometry hold iconName	721	display_name embed ext_bwidth fade font geometry hold iconName
449	imFont imLocale inputMethod insecure int_bwidth intensityStyles	722	imFont imLocale inputMethod insecure int_bwidth intensityStyles
450	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	723	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
451	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	724	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
452	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	725	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
453	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	726	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
454	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	727	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
455	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	728	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
456	shade term_name title transparent transparent_all tripleclickwords	729	shade term_name title transparent transparent_all tripleclickwords
457	utmpInhibit visualBell	730	utmpInhibit visualBell
458		731
459	=cut	732	=cut
460		733
461	sub urxvt::term::resource($$;$) {	734	sub resource($$;$) {
462	my ($self, $name) = (shift, shift);	735	my ($self, $name) = (shift, shift);
463	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	736	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
464	goto &urxvt::term::_resource;	737	&urxvt::term::_resource
465	}	738	}
		739
		740	=item $rend = $term->rstyle ([$new_rstyle])
		741
		742	Return and optionally change the current rendition. Text that is output by
		743	the terminal application will use this style.
		744
		745	=item ($row, $col) = $term->screen_cur ([$row, $col])
		746
		747	Return the current coordinates of the text cursor position and optionally
		748	set it (which is usually bad as applications don't expect that).
466		749
467	=item ($row, $col) = $term->selection_mark ([$row, $col])	750	=item ($row, $col) = $term->selection_mark ([$row, $col])
468		751
469	=item ($row, $col) = $term->selection_beg ([$row, $col])	752	=item ($row, $col) = $term->selection_beg ([$row, $col])
470		753
…		…
485	#=item $term->overlay ($x, $y, $text)	768	#=item $term->overlay ($x, $y, $text)
486	#	769	#
487	#Create a simple multi-line overlay box. See the next method for details.	770	#Create a simple multi-line overlay box. See the next method for details.
488	#	771	#
489	#=cut	772	#=cut
490		773	#
491	sub urxvt::term::scr_overlay {	774	#sub urxvt::term::scr_overlay {
492	die;
493	my ($self, $x, $y, $text) = @_;	775	# my ($self, $x, $y, $text) = @_;
494		776	#
495	my @lines = split /\n/, $text;	777	# my @lines = split /\n/, $text;
496		778	#
497	my $w = 0;	779	# my $w = 0;
498	for (map $self->strwidth ($_), @lines) {	780	# for (map $self->strwidth ($_), @lines) {
499	$w = $_ if $w < $_;	781	# $w = $_ if $w < $_;
500	}	782	# }
501		783	#
502	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	784	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
503	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	785	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
504	}	786	#}
505		787
506	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	788	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
507		789
508	Create a new (empty) overlay at the given position with the given	790	Create a new (empty) overlay at the given position with the given
509	width/height. C<$rstyle> defines the initial rendition style	791	width/height. C<$rstyle> defines the initial rendition style
…		…
536		818
537	If hidden, display the overlay again.	819	If hidden, display the overlay again.
538		820
539	=back	821	=back
540		822
		823	=item $popup = $term->popup ($event)
		824
		825	Creates a new C<urxvt::popup> object that implements a popup menu. The
		826	C<$event> I<must> be the event causing the menu to pop up (a button event,
		827	currently).
		828
		829	=cut
		830
		831	sub popup {
		832	my ($self, $event) = @_;
		833
		834	$self->grab ($event->{time}, 1)
		835	or return;
		836
		837	my $popup = bless {
		838	term => $self,
		839	event => $event,
		840	}, urxvt::popup::;
		841
		842	Scalar::Util::weaken $popup->{term};
		843
		844	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		845	Scalar::Util::weaken $self->{_destroy}{$popup};
		846
		847	$popup
		848	}
		849
541	=item $cellwidth = $term->strwidth $string	850	=item $cellwidth = $term->strwidth ($string)
542		851
543	Returns the number of screen-cells this string would need. Correctly	852	Returns the number of screen-cells this string would need. Correctly
544	accounts for wide and combining characters.	853	accounts for wide and combining characters.
545		854
546	=item $octets = $term->locale_encode $string	855	=item $octets = $term->locale_encode ($string)
547		856
548	Convert the given text string into the corresponding locale encoding.	857	Convert the given text string into the corresponding locale encoding.
549		858
550	=item $string = $term->locale_decode $octets	859	=item $string = $term->locale_decode ($octets)
551		860
552	Convert the given locale-encoded octets into a perl string.	861	Convert the given locale-encoded octets into a perl string.
		862
		863	=item $term->scr_add_lines ($string)
		864
		865	Write the given text string to the screen, as if output by the application
		866	running inside the terminal. It may not contain command sequences (escape
		867	codes), but is free to use line feeds, carriage returns and tabs. The
		868	string is a normal text string, not in locale-dependent encoding.
		869
		870	Normally its not a good idea to use this function, as programs might be
		871	confused by changes in cursor position or scrolling. Its useful inside a
		872	C<on_add_lines> hook, though.
		873
		874	=item $term->cmd_parse ($octets)
		875
		876	Similar to C<scr_add_lines>, but the argument must be in the
		877	locale-specific encoding of the terminal and can contain command sequences
		878	(escape codes) that will be interpreted.
553		879
554	=item $term->tt_write ($octets)	880	=item $term->tt_write ($octets)
555		881
556	Write the octets given in C<$data> to the tty (i.e. as program input). To	882	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	883	pass characters instead of octets, you should convert your strings first
558	to the locale-specific encoding using C<< $term->locale_encode >>.	884	to the locale-specific encoding using C<< $term->locale_encode >>.
559		885
		886	=item $windowid = $term->parent
		887
		888	Return the window id of the toplevel window.
		889
		890	=item $windowid = $term->vt
		891
		892	Return the window id of the terminal window.
		893
		894	=item $window_width = $term->width
		895
		896	=item $window_height = $term->height
		897
		898	=item $font_width = $term->fwidth
		899
		900	=item $font_height = $term->fheight
		901
		902	=item $font_ascent = $term->fbase
		903
560	=item $nrow = $term->nrow	904	=item $terminal_rows = $term->nrow
561		905
562	=item $ncol = $term->ncol	906	=item $terminal_columns = $term->ncol
563		907
564	Return the number of rows/columns of the terminal window (i.e. as	908	=item $has_focus = $term->focus
565	specified by C<-geometry>, excluding any scrollback).
566		909
567	=item $nsaved = $term->nsaved	910	=item $is_mapped = $term->mapped
568		911
569	Returns the number of lines in the scrollback buffer.	912	=item $max_scrollback = $term->saveLines
		913
		914	=item $nrow_plus_saveLines = $term->total_rows
		915
		916	=item $lines_in_scrollback = $term->nsaved
		917
		918	Return various integers describing terminal characteristics.
		919
		920	=item $modifiermask = $term->ModLevel3Mask
		921
		922	=item $modifiermask = $term->ModMetaMask
		923
		924	=item $modifiermask = $term->ModNumLockMask
		925
		926	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		927	AltGr), the meta key (often Alt) and the num lock key, if applicable.
570		928
571	=item $view_start = $term->view_start ([$newvalue])	929	=item $view_start = $term->view_start ([$newvalue])
572		930
573	Returns the negative row number of the topmost line. Minimum value is	931	Returns the negative row number of the topmost line. Minimum value is
574	C<0>, which displays the normal terminal contents. Larger values scroll	932	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	995	about the logical line that row C<$row_number> is part of. It supports the
638	following methods:	996	following methods:
639		997
640	=over 4	998	=over 4
641		999
642	=item $text = $line->t	1000	=item $text = $line->t ([$new_text])
643		1001
644	Returns the full text of the line, similar to C<ROW_t>	1002	Returns or replaces the full text of the line, similar to C<ROW_t>
645		1003
646	=item $rend = $line->r	1004	=item $rend = $line->r ([$new_rend])
647		1005
648	Returns the full rendition array of the line, similar to C<ROW_r>	1006	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
649		1007
650	=item $length = $line->l	1008	=item $length = $line->l
651		1009
652	Returns the length of the line in cells, similar to C<ROW_l>.	1010	Returns the length of the line in cells, similar to C<ROW_l>.
653		1011
…		…
668		1026
669	=back	1027	=back
670		1028
671	=cut	1029	=cut
672		1030
673	sub urxvt::term::line {	1031	sub line {
674	my ($self, $row) = @_;	1032	my ($self, $row) = @_;
675		1033
676	my $maxrow = $self->nrow - 1;	1034	my $maxrow = $self->nrow - 1;
677		1035
678	my ($beg, $end) = ($row, $row);	1036	my ($beg, $end) = ($row, $row);
…		…
682		1040
683	bless {	1041	bless {
684	term => $self,	1042	term => $self,
685	beg => $beg,	1043	beg => $beg,
686	end => $end,	1044	end => $end,
		1045	ncol => $self->ncol,
687	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1046	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
688	}, urxvt::line::	1047	}, urxvt::line::
689	}	1048	}
690		1049
691	sub urxvt::line::t {	1050	sub urxvt::line::t {
692	my ($self) = @_;	1051	my ($self) = @_;
693		1052
		1053	if (@_ > 1)
		1054	{
		1055	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1056	for $self->{beg} .. $self->{end};
		1057	}
		1058
		1059	defined wantarray &&
694	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1060	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
695	0, $self->{len}	1061	0, $self->{len}
696	}	1062	}
697		1063
698	sub urxvt::line::r {	1064	sub urxvt::line::r {
699	my ($self) = @_;	1065	my ($self) = @_;
700		1066
		1067	if (@_ > 1)
		1068	{
		1069	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1070	for $self->{beg} .. $self->{end};
		1071	}
		1072
		1073	if (defined wantarray) {
701	my $rend = [	1074	my $rend = [
702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1075	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
703	];	1076	];
704	$#$rend = $self->{len} - 1;	1077	$#$rend = $self->{len} - 1;
705	$rend	1078	return $rend;
		1079	}
		1080
		1081	()
706	}	1082	}
707		1083
708	sub urxvt::line::beg { $_[0]{beg} }	1084	sub urxvt::line::beg { $_[0]{beg} }
709	sub urxvt::line::end { $_[0]{end} }	1085	sub urxvt::line::end { $_[0]{end} }
710	sub urxvt::line::l { $_[0]{len} }	1086	sub urxvt::line::l { $_[0]{len} }
711		1087
712	sub urxvt::line::offset_of {	1088	sub urxvt::line::offset_of {
713	my ($self, $row, $col) = @_;	1089	my ($self, $row, $col) = @_;
714		1090
715	($row - $self->{beg}) * $self->{term}->ncol + $col	1091	($row - $self->{beg}) * $self->{ncol} + $col
716	}	1092	}
717		1093
718	sub urxvt::line::coord_of {	1094	sub urxvt::line::coord_of {
719	my ($self, $offset) = @_;	1095	my ($self, $offset) = @_;
720		1096
721	use integer;	1097	use integer;
722		1098
723	(	1099	(
724	$offset / $self->{term}->ncol + $self->{beg},	1100	$offset / $self->{ncol} + $self->{beg},
725	$offset % $self->{term}->ncol	1101	$offset % $self->{ncol}
726	)	1102	)
727	}	1103	}
728		1104
729	=item ($row, $col) = $line->coord_of ($offset)	1105	=item ($row, $col) = $line->coord_of ($offset)
730	=item $text = $term->special_encode $string	1106	=item $text = $term->special_encode $string
…		…
737		1113
738	Converts rxvt-unicodes text reprsentation into a perl string. See	1114	Converts rxvt-unicodes text reprsentation into a perl string. See
739	C<< $term->ROW_t >> for details.	1115	C<< $term->ROW_t >> for details.
740		1116
741	=back	1117	=back
		1118
		1119	=cut
		1120
		1121	package urxvt::popup;
		1122
		1123	=head2 The C<urxvt::popup> Class
		1124
		1125	=over 4
		1126
		1127	=cut
		1128
		1129	sub add_item {
		1130	my ($self, $item) = @_;
		1131
		1132	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1133	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1134	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1135
		1136	$item->{render} \|\|= sub { $_[0]{text} };
		1137
		1138	push @{ $self->{item} }, $item;
		1139	}
		1140
		1141	sub add_separator {
		1142	my ($self, $sep) = @_;
		1143
		1144	$sep \|\|= "═";
		1145
		1146	$self->add_item ({
		1147	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1148	text => "",
		1149	render => sub { $sep x $urxvt::TERM->ncol },
		1150	activate => sub { },
		1151	});
		1152	}
		1153
		1154	sub add_title {
		1155	my ($self, $title) = @_;
		1156
		1157	$self->add_item ({
		1158	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1159	text => $title,
		1160	activate => sub { },
		1161	});
		1162	}
		1163
		1164	sub add_button {
		1165	my ($self, $text, $cb) = @_;
		1166
		1167	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1168	}
		1169
		1170	sub add_toggle {
		1171	my ($self, $text, $cb, $value) = @_;
		1172
		1173	my $item; $item = {
		1174	type => "button",
		1175	text => " $text",
		1176	value => $value,
		1177	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1178	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1179	};
		1180
		1181	$self->add_item ($item);
		1182	}
		1183
		1184	sub show {
		1185	my ($self) = @_;
		1186
		1187	local $urxvt::popup::self = $self;
		1188
		1189	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1190	"--transient-for" => $self->{term}->parent,
		1191	"-pe" => "urxvt-popup")
		1192	or die "unable to create popup window\n";
		1193	}
		1194
		1195	sub DESTROY {
		1196	my ($self) = @_;
		1197
		1198	delete $self->{term}{_destroy}{$self};
		1199	$self->{term}->ungrab;
		1200	}
742		1201
743	=head2 The C<urxvt::timer> Class	1202	=head2 The C<urxvt::timer> Class
744		1203
745	This class implements timer watchers/events. Time is represented as a	1204	This class implements timer watchers/events. Time is represented as a
746	fractional number of seconds since the epoch. Example:	1205	fractional number of seconds since the epoch. Example:
…		…
848	This variable controls the verbosity level of the perl extension. Higher	1307	This variable controls the verbosity level of the perl extension. Higher
849	numbers indicate more verbose output.	1308	numbers indicate more verbose output.
850		1309
851	=over 4	1310	=over 4
852		1311
853	=item 0 - only fatal messages	1312	=item == 0 - fatal messages
854		1313
855	=item 3 - script loading and management	1314	=item >= 3 - script loading and management
856		1315
857	=item 10 - all events received	1316	=item >=10 - all events received
858		1317
859	=back	1318	=back
860		1319
861	=head1 AUTHOR	1320	=head1 AUTHOR
862		1321

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.60 by root, Mon Jan 9 01:21:43 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.60 by root, Mon Jan 9 01:21:43 2006 UTC