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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC vs.
Revision 1.59 by root, Mon Jan 9 00:34:36 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
…		…
71	=head2 General API Considerations	93	=head2 General API Considerations
72		94
73	All objects (such as terminals, time watchers etc.) are typical	95	All objects (such as terminals, time watchers etc.) are typical
74	reference-to-hash objects. The hash can be used to store anything you	96	reference-to-hash objects. The hash can be used to store anything you
75	like. All members starting with an underscore (such as C<_ptr> or	97	like. All members starting with an underscore (such as C<_ptr> or
76	C<_hook>) are reserved for internal uses and must not be accessed or	98	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
77	modified).	99	modified).
78		100
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 called	131	The following subroutines can be declared in extension files, and will be
87	whenever the relevant event happens.	132	called whenever the relevant event happens.
		133
		134	The first argument passed to them is an object private to each terminal
		135	and extension package. You can call all C<urxvt::term> methods on it, but
		136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		137	object that is shared between all packages is stored in the C<term>
		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.
88		140
89	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
90	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,
91	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.
92		144
…		…
95	=over 4	147	=over 4
96		148
97	=item on_init $term	149	=item on_init $term
98		150
99	Called after a new terminal object has been initialized, but before	151	Called after a new terminal object has been initialized, but before
100	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.
101		156
102	=item on_reset $term	157	=item on_reset $term
103		158
104	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
105	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
…		…
134	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
135	processing.	190	processing.
136		191
137	See the F<selection> example extension.	192	See the F<selection> example extension.
138		193
139	=item on_focus_in $term
140
141	Called whenever the window gets the keyboard focus, before urxvt does
142	focus in processing.
143
144	=item on_focus_out $term
145
146	Called wheneever the window loses keyboard focus, before urxvt does focus
147	out processing.
148
149	=item on_view_change $term, $offset	194	=item on_view_change $term, $offset
150		195
151	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
152	scrolls. Offset C<0> means display the normal terminal, positive values	197	scrolls. Offset C<0> means display the normal terminal, positive values
153	show this many lines of scrollback.	198	show this many lines of scrollback.
…		…
163	number of lines that will be in the scrollback buffer.	208	number of lines that will be in the scrollback buffer.
164		209
165	=item on_tty_activity $term NYI	210	=item on_tty_activity $term NYI
166		211
167	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.
168		248
169	=item on_refresh_begin $term	249	=item on_refresh_begin $term
170		250
171	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
172	or similar effects by modify terminal contents in refresh_begin, and	252	or similar effects by modify terminal contents in refresh_begin, and
…		…
181		261
182	Called whenever the user presses a key combination that has a	262	Called whenever the user presses a key combination that has a
183	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>
184	resource in the @@RXVT_NAME@@(1) manpage).	264	resource in the @@RXVT_NAME@@(1) manpage).
185		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
186	=back	302	=back
187		303
		304	=head2 Variables in the C<urxvt> Package
		305
		306	=over 4
		307
		308	=item $urxvt::TERM
		309
		310	The current terminal. This variable stores the current C<urxvt::term>
		311	object, whenever a callback/hook is executing.
		312
		313	=back
		314
188	=head2 Functions in the C<urxvt> Package	315	=head2 Functions in the C<urxvt> Package
189		316
190	=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.
191		326
192	=item urxvt::fatal $errormessage	327	=item urxvt::fatal $errormessage
193		328
194	Fatally aborts execution with the given error message. Avoid at all	329	Fatally aborts execution with the given error message. Avoid at all
195	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
…		…
205	correct place, e.g. on stderr of the connecting urxvtc client.	340	correct place, e.g. on stderr of the connecting urxvtc client.
206		341
207	=item $time = urxvt::NOW	342	=item $time = urxvt::NOW
208		343
209	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.
210		353
211	=back	354	=back
212		355
213	=head2 RENDITION	356	=head2 RENDITION
214		357
…		…
264		407
265	=cut	408	=cut
266		409
267	package urxvt;	410	package urxvt;
268		411
		412	use utf8;
269	use strict;	413	use strict;
		414	use Scalar::Util ();
		415	use List::Util ();
270		416
271	our $term;	417	our $VERSION = 1;
		418	our $TERM;
272	our @HOOKNAME;	419	our @HOOKNAME;
		420	our %OPTION;
273	our $LIBDIR;	421	our $LIBDIR;
274		422
275	BEGIN {	423	BEGIN {
276	urxvt->bootstrap;	424	urxvt->bootstrap;
277		425
…		…
280	my $msg = join "", @_;	428	my $msg = join "", @_;
281	$msg .= "\n"	429	$msg .= "\n"
282	unless $msg =~ /\n$/;	430	unless $msg =~ /\n$/;
283	urxvt::warn ($msg);	431	urxvt::warn ($msg);
284	};	432	};
		433
		434	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
		435	delete $ENV{CDPATH};
285	}	436	}
286		437
287	my @hook_count;	438	my @hook_count;
288	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	439	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
289		440
…		…
301	my $name = $HOOKNAME[$htype];	452	my $name = $HOOKNAME[$htype];
302		453
303	my $ref = $pkg->can ("on_" . lc $name)	454	my $ref = $pkg->can ("on_" . lc $name)
304	or next;	455	or next;
305		456
306	$term->{_hook}[$htype]{$ref*1} = $ref;	457	$TERM->{_hook}[$htype]{$pkg} = $ref;
307	$hook_count[$htype]++	458	$hook_count[$htype]++
308	or set_should_invoke $htype, 1;	459	or set_should_invoke $htype, 1;
309	}	460	}
310	}	461	}
311		462
312	my $script_pkg = "script0000";	463	my $extension_pkg = "extension0000";
313	my %script_pkg;	464	my %extension_pkg;
314		465
315	# load a single script into its own package, once only	466	# load a single script into its own package, once only
316	sub script_package($) {	467	sub extension_package($) {
317	my ($path) = @_;	468	my ($path) = @_;
318		469
319	$script_pkg{$path} \|\|= do {	470	$extension_pkg{$path} \|\|= do {
320	my $pkg = "urxvt::" . ($script_pkg++);	471	my $pkg = "urxvt::" . ($extension_pkg++);
321		472
322	verbose 3, "loading script '$path' into package '$pkg'";	473	verbose 3, "loading extension '$path' into package '$pkg'";
323		474
324	open my $fh, "<:raw", $path	475	open my $fh, "<:raw", $path
325	or die "$path: $!";	476	or die "$path: $!";
326		477
327	my $source = "package $pkg; use strict; use utf8;\n"	478	my $source = untaint "package $pkg; use strict; use utf8;\n"
		479	. "use base urxvt::term::proxy::;\n"
328	. "#line 1 \"$path\"\n{\n"	480	. "#line 1 \"$path\"\n{\n"
329	. (do { local $/; <$fh> })	481	. (do { local $/; <$fh> })
330	. "\n};\n1";	482	. "\n};\n1";
331		483
332	eval $source or die "$path: $@";	484	eval $source or die "$path: $@";
333		485
334	$pkg	486	$pkg
335	}	487	}
336	}	488	}
337		489
		490	our $retval; # return value for urxvt
		491
338	# called by the rxvt core	492	# called by the rxvt core
339	sub invoke {	493	sub invoke {
340	local $term = shift;	494	local $TERM = shift;
341	my $htype = shift;	495	my $htype = shift;
342		496
343	if ($htype == 0) { # INIT	497	if ($htype == 0) { # INIT
344	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	498	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		499
		500	my %want_ext;
345		501
346	for my $ext (split /:/, $term->resource ("perl_ext")) {	502	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		503	if ($_ eq "default") {
		504	$want_ext{$_}++ for qw(selection option-popup selection-popup);
		505	} elsif (/^-(.*)$/) {
		506	delete $want_ext{$1};
		507	} else {
		508	$want_ext{$_}++;
		509	}
		510	}
		511
		512	for my $ext (keys %want_ext) {
347	my @files = grep -f $_, map "$_/$ext", @dirs;	513	my @files = grep -f $_, map "$_/$ext", @dirs;
348		514
349	if (@files) {	515	if (@files) {
350	register_package script_package $files[0];	516	register_package extension_package $files[0];
351	} else {	517	} else {
352	warn "perl extension '$ext' not found in perl library search path\n";	518	warn "perl extension '$ext' not found in perl library search path\n";
353	}	519	}
354	}	520	}
355		521
		522	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		523	warn $@ if $@;
		524	}
		525
		526	$retval = undef;
		527
		528	if (my $cb = $TERM->{_hook}[$htype]) {
		529	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		530	if $verbosity >= 10;
		531
		532	keys %$cb;
		533
		534	while (my ($pkg, $cb) = each %$cb) {
		535	eval {
		536	$retval = $cb->(
		537	$TERM->{_pkg}{$pkg} \|\|= do {
		538	my $proxy = bless { }, $pkg;
		539	Scalar::Util::weaken ($proxy->{term} = $TERM);
		540	$proxy
		541	},
		542	@_,
		543	) and last;
		544	};
		545	if ($@) {
		546	$TERM->ungrab; # better to lose the grab than the session
		547	warn $@;
		548	}
		549	}
		550	}
		551
356	} elsif ($htype == 1) { # DESTROY	552	if ($htype == 1) { # DESTROY
		553	# remove hooks if unused
357	if (my $hook = $term->{_hook}) {	554	if (my $hook = $TERM->{_hook}) {
358	for my $htype (0..$#$hook) {	555	for my $htype (0..$#$hook) {
359	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	556	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
360	or set_should_invoke $htype, 0;	557	or set_should_invoke $htype, 0;
361	}	558	}
362	}	559	}
		560
		561	# clear package objects
		562	%$_ = () for values %{ $TERM->{_pkg} };
		563
		564	# clear package
		565	%$TERM = ();
363	}	566	}
364		567
365	my $cb = $term->{_hook}[$htype]	568	$retval
366	or return;	569	}
367		570
368	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	571	# urxvt::term::proxy
369	if $verbosity >= 10;
370		572
371	while (my ($k, $v) = each %$cb) {	573	sub urxvt::term::proxy::AUTOLOAD {
372	return 1 if $v->($term, @_);	574	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		575	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		576
		577	eval qq{
		578	sub $urxvt::term::proxy::AUTOLOAD {
		579	my \$proxy = shift;
		580	\$proxy->{term}->$1 (\@_)
		581	}
		582	1
		583	} or die "FATAL: unable to compile method forwarder: $@";
		584
		585	goto &$urxvt::term::proxy::AUTOLOAD;
		586	}
		587
		588	sub urxvt::term::proxy::DESTROY {
		589	# nop
		590	}
		591
		592	# urxvt::destroy_hook
		593
		594	sub urxvt::destroy_hook::DESTROY {
		595	${$_[0]}->();
		596	}
		597
		598	sub urxvt::destroy_hook(&) {
		599	bless \shift, urxvt::destroy_hook::
		600	}
		601
		602	package urxvt::anyevent;
		603
		604	=head2 The C<urxvt::anyevent> Class
		605
		606	The sole purpose of this class is to deliver an interface to the
		607	C<AnyEvent> module - any module using it will work inside urxvt without
		608	further work. The only exception is that you cannot wait on condition
		609	variables, but non-blocking condvar use is ok. What this means is that you
		610	cannot use blocking APIs, but the non-blocking variant should work.
		611
		612	=cut
		613
		614	our $VERSION = 1;
		615
		616	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		617	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		618
		619	sub timer {
		620	my ($class, %arg) = @_;
		621
		622	my $cb = $arg{cb};
		623
		624	urxvt::timer
		625	->new
		626	->start (urxvt::NOW + $arg{after})
		627	->cb (sub {
		628	$_[0]->stop; # need to cancel manually
		629	$cb->();
		630	})
		631	}
		632
		633	sub io {
		634	my ($class, %arg) = @_;
		635
		636	my $cb = $arg{cb};
		637
		638	bless [$arg{fh}, urxvt::iow
		639	->new
		640	->fd (fileno $arg{fh})
		641	->events (($arg{poll} =~ /r/ ? 1 : 0)
		642	\| ($arg{poll} =~ /w/ ? 2 : 0))
		643	->start
		644	->cb (sub {
		645	$cb->(($_[1] & 1 ? 'r' : '')
		646	. ($_[1] & 2 ? 'w' : ''));
		647	})],
		648	urxvt::anyevent::
		649	}
		650
		651	sub DESTROY {
		652	$_[0][1]->stop;
		653	}
		654
		655	sub condvar {
		656	bless \my $flag, urxvt::anyevent::condvar::
		657	}
		658
		659	sub urxvt::anyevent::condvar::broadcast {
		660	${$_[0]}++;
		661	}
		662
		663	sub urxvt::anyevent::condvar::wait {
		664	unless (${$_[0]}) {
		665	require Carp;
		666	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
373	}	667	}
374
375	0
376	}	668	}
		669
		670	package urxvt::term;
377		671
378	=head2 The C<urxvt::term> Class	672	=head2 The C<urxvt::term> Class
379		673
380	=over 4	674	=over 4
		675
		676	=item $term->destroy
		677
		678	Destroy the terminal object (close the window, free resources etc.).
		679
		680	=item $isset = $term->option ($optval[, $set])
		681
		682	Returns true if the option specified by C<$optval> is enabled, and
		683	optionally change it. All option values are stored by name in the hash
		684	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		685
		686	Here is a a likely non-exhaustive list of option names, please see the
		687	source file F</src/optinc.h> to see the actual list:
		688
		689	borderLess console cursorBlink cursorUnderline hold iconic insecure
		690	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		691	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		692	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		693	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		694	tripleclickwords utmpInhibit visualBell
381		695
382	=item $value = $term->resource ($name[, $newval])	696	=item $value = $term->resource ($name[, $newval])
383		697
384	Returns the current resource value associated with a given name and	698	Returns the current resource value associated with a given name and
385	optionally sets a new value. Setting values is most useful in the C<init>	699	optionally sets a new value. Setting values is most useful in the C<init>
…		…
395		709
396	Please note that resource strings will currently only be freed when the	710	Please note that resource strings will currently only be freed when the
397	terminal is destroyed, so changing options frequently will eat memory.	711	terminal is destroyed, so changing options frequently will eat memory.
398		712
399	Here is a a likely non-exhaustive list of resource names, not all of which	713	Here is a a likely non-exhaustive list of resource names, not all of which
400	are supported in every build, please see the source to see the actual	714	are supported in every build, please see the source file F</src/rsinc.h>
401	list:	715	to see the actual list:
402		716
403	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	717	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
404	borderLess color cursorBlink cursorUnderline cutchars delete_key	718	borderLess color cursorBlink cursorUnderline cutchars delete_key
405	display_name embed ext_bwidth fade font geometry hold iconName	719	display_name embed ext_bwidth fade font geometry hold iconName
406	imFont imLocale inputMethod insecure int_bwidth intensityStyles	720	imFont imLocale inputMethod insecure int_bwidth intensityStyles
407	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	721	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
408	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	722	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
409	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	723	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
410	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	724	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
411	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	725	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
412	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	726	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
413	shade term_name title transparent transparent_all tripleclickwords	727	shade term_name title transparent transparent_all tripleclickwords
414	utmpInhibit visualBell	728	utmpInhibit visualBell
415		729
416	=cut	730	=cut
417		731
418	sub urxvt::term::resource($$;$) {	732	sub resource($$;$) {
419	my ($self, $name) = (shift, shift);	733	my ($self, $name) = (shift, shift);
420	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	734	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
421	goto &urxvt::term::_resource;	735	&urxvt::term::_resource
422	}	736	}
		737
		738	=item $rend = $term->rstyle ([$new_rstyle])
		739
		740	Return and optionally change the current rendition. Text that is output by
		741	the terminal application will use this style.
		742
		743	=item ($row, $col) = $term->screen_cur ([$row, $col])
		744
		745	Return the current coordinates of the text cursor position and optionally
		746	set it (which is usually bad as applications don't expect that).
423		747
424	=item ($row, $col) = $term->selection_mark ([$row, $col])	748	=item ($row, $col) = $term->selection_mark ([$row, $col])
425		749
426	=item ($row, $col) = $term->selection_beg ([$row, $col])	750	=item ($row, $col) = $term->selection_beg ([$row, $col])
427		751
…		…
442	#=item $term->overlay ($x, $y, $text)	766	#=item $term->overlay ($x, $y, $text)
443	#	767	#
444	#Create a simple multi-line overlay box. See the next method for details.	768	#Create a simple multi-line overlay box. See the next method for details.
445	#	769	#
446	#=cut	770	#=cut
447		771	#
448	sub urxvt::term::scr_overlay {	772	#sub urxvt::term::scr_overlay {
449	die;
450	my ($self, $x, $y, $text) = @_;	773	# my ($self, $x, $y, $text) = @_;
451		774	#
452	my @lines = split /\n/, $text;	775	# my @lines = split /\n/, $text;
453		776	#
454	my $w = 0;	777	# my $w = 0;
455	for (map $self->strwidth ($_), @lines) {	778	# for (map $self->strwidth ($_), @lines) {
456	$w = $_ if $w < $_;	779	# $w = $_ if $w < $_;
457	}	780	# }
458		781	#
459	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	782	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
460	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	783	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
461	}	784	#}
462		785
463	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	786	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
464		787
465	Create a new (empty) overlay at the given position with the given	788	Create a new (empty) overlay at the given position with the given
466	width/height. C<$rstyle> defines the initial rendition style	789	width/height. C<$rstyle> defines the initial rendition style
…		…
493		816
494	If hidden, display the overlay again.	817	If hidden, display the overlay again.
495		818
496	=back	819	=back
497		820
		821	=item $popup = $term->popup ($event)
		822
		823	Creates a new C<urxvt::popup> object that implements a popup menu. The
		824	C<$event> I<must> be the event causing the menu to pop up (a button event,
		825	currently).
		826
		827	=cut
		828
		829	sub popup {
		830	my ($self, $event) = @_;
		831
		832	$self->grab ($event->{time}, 1)
		833	or return;
		834
		835	my $popup = bless {
		836	term => $self,
		837	event => $event,
		838	}, urxvt::popup::;
		839
		840	Scalar::Util::weaken $popup->{term};
		841
		842	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		843	Scalar::Util::weaken $self->{_destroy}{$popup};
		844
		845	$popup
		846	}
		847
498	=item $cellwidth = $term->strwidth $string	848	=item $cellwidth = $term->strwidth ($string)
499		849
500	Returns the number of screen-cells this string would need. Correctly	850	Returns the number of screen-cells this string would need. Correctly
501	accounts for wide and combining characters.	851	accounts for wide and combining characters.
502		852
503	=item $octets = $term->locale_encode $string	853	=item $octets = $term->locale_encode ($string)
504		854
505	Convert the given text string into the corresponding locale encoding.	855	Convert the given text string into the corresponding locale encoding.
506		856
507	=item $string = $term->locale_decode $octets	857	=item $string = $term->locale_decode ($octets)
508		858
509	Convert the given locale-encoded octets into a perl string.	859	Convert the given locale-encoded octets into a perl string.
		860
		861	=item $term->scr_add_lines ($string)
		862
		863	Write the given text string to the screen, as if output by the application
		864	running inside the terminal. It may not contain command sequences (escape
		865	codes), but is free to use line feeds, carriage returns and tabs. The
		866	string is a normal text string, not in locale-dependent encoding.
		867
		868	Normally its not a good idea to use this function, as programs might be
		869	confused by changes in cursor position or scrolling. Its useful inside a
		870	C<on_add_lines> hook, though.
		871
		872	=item $term->cmd_parse ($octets)
		873
		874	Similar to C<scr_add_lines>, but the argument must be in the
		875	locale-specific encoding of the terminal and can contain command sequences
		876	(escape codes) that will be interpreted.
510		877
511	=item $term->tt_write ($octets)	878	=item $term->tt_write ($octets)
512		879
513	Write the octets given in C<$data> to the tty (i.e. as program input). To	880	Write the octets given in C<$data> to the tty (i.e. as program input). To
514	pass characters instead of octets, you should convert your strings first	881	pass characters instead of octets, you should convert your strings first
515	to the locale-specific encoding using C<< $term->locale_encode >>.	882	to the locale-specific encoding using C<< $term->locale_encode >>.
516		883
		884	=item $windowid = $term->parent
		885
		886	Return the window id of the toplevel window.
		887
		888	=item $windowid = $term->vt
		889
		890	Return the window id of the terminal window.
		891
		892	=item $window_width = $term->width
		893
		894	=item $window_height = $term->height
		895
		896	=item $font_width = $term->fwidth
		897
		898	=item $font_height = $term->fheight
		899
		900	=item $font_ascent = $term->fbase
		901
517	=item $nrow = $term->nrow	902	=item $terminal_rows = $term->nrow
518		903
519	=item $ncol = $term->ncol	904	=item $terminal_columns = $term->ncol
520		905
521	Return the number of rows/columns of the terminal window (i.e. as	906	=item $has_focus = $term->focus
522	specified by C<-geometry>, excluding any scrollback).
523		907
524	=item $nsaved = $term->nsaved	908	=item $is_mapped = $term->mapped
525		909
526	Returns the number of lines in the scrollback buffer.	910	=item $max_scrollback = $term->saveLines
		911
		912	=item $nrow_plus_saveLines = $term->total_rows
		913
		914	=item $lines_in_scrollback = $term->nsaved
		915
		916	Return various integers describing terminal characteristics.
		917
		918	=item $modifiermask = $term->ModLevel3Mask
		919
		920	=item $modifiermask = $term->ModMetaMask
		921
		922	=item $modifiermask = $term->ModNumLockMask
		923
		924	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		925	AltGr), the meta key (often Alt) and the num lock key, if applicable.
527		926
528	=item $view_start = $term->view_start ([$newvalue])	927	=item $view_start = $term->view_start ([$newvalue])
529		928
530	Returns the negative row number of the topmost line. Minimum value is	929	Returns the negative row number of the topmost line. Minimum value is
531	C<0>, which displays the normal terminal contents. Larger values scroll	930	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
542	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	941	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
543		942
544	Returns the text of the entire row with number C<$row_number>. Row C<0>	943	Returns the text of the entire row with number C<$row_number>. Row C<0>
545	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	944	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
546	terminal line. The scrollback buffer starts at line C<-1> and extends to	945	terminal line. The scrollback buffer starts at line C<-1> and extends to
547	line C<< -$term->nsaved >>.	946	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		947	is requested.
548		948
549	If C<$new_text> is specified, it will replace characters in the current	949	If C<$new_text> is specified, it will replace characters in the current
550	line, starting at column C<$start_col> (default C<0>), which is useful	950	line, starting at column C<$start_col> (default C<0>), which is useful
551	to replace only parts of a line. The font index in the rendition will	951	to replace only parts of a line. The font index in the rendition will
552	automatically be updated.	952	automatically be updated.
…		…
574		974
575	See the section on RENDITION, above.	975	See the section on RENDITION, above.
576		976
577	=item $length = $term->ROW_l ($row_number[, $new_length])	977	=item $length = $term->ROW_l ($row_number[, $new_length])
578		978
579	Returns the number of screen cells that are in use ("the line length"). If	979	Returns the number of screen cells that are in use ("the line
580	it is C<-1>, then the line is part of a multiple-row logical "line", which	980	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
581	means all characters are in use and it is continued on the next row.	981	line is joined with the following one.
582		982
		983	=item $bool = $term->is_longer ($row_number)
		984
		985	Returns true if the row is part of a multiple-row logical "line" (i.e.
		986	joined with the following row), which means all characters are in use
		987	and it is continued on the next row (and possibly a continuation of the
		988	previous row(s)).
		989
		990	=item $line = $term->line ($row_number)
		991
		992	Create and return a new C<urxvt::line> object that stores information
		993	about the logical line that row C<$row_number> is part of. It supports the
		994	following methods:
		995
		996	=over 4
		997
		998	=item $text = $line->t ([$new_text])
		999
		1000	Returns or replaces the full text of the line, similar to C<ROW_t>
		1001
		1002	=item $rend = $line->r ([$new_rend])
		1003
		1004	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		1005
		1006	=item $length = $line->l
		1007
		1008	Returns the length of the line in cells, similar to C<ROW_l>.
		1009
		1010	=item $rownum = $line->beg
		1011
		1012	=item $rownum = $line->end
		1013
		1014	Return the row number of the first/last row of the line, respectively.
		1015
		1016	=item $offset = $line->offset_of ($row, $col)
		1017
		1018	Returns the character offset of the given row\|col pair within the logical
		1019	line.
		1020
		1021	=item ($row, $col) = $line->coord_of ($offset)
		1022
		1023	Translates a string offset into terminal coordinates again.
		1024
		1025	=back
		1026
		1027	=cut
		1028
		1029	sub line {
		1030	my ($self, $row) = @_;
		1031
		1032	my $maxrow = $self->nrow - 1;
		1033
		1034	my ($beg, $end) = ($row, $row);
		1035
		1036	--$beg while $self->ROW_is_longer ($beg - 1);
		1037	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1038
		1039	bless {
		1040	term => $self,
		1041	beg => $beg,
		1042	end => $end,
		1043	ncol => $self->ncol,
		1044	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1045	}, urxvt::line::
		1046	}
		1047
		1048	sub urxvt::line::t {
		1049	my ($self) = @_;
		1050
		1051	if (@_ > 1)
		1052	{
		1053	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1054	for $self->{beg} .. $self->{end};
		1055	}
		1056
		1057	defined wantarray &&
		1058	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1059	0, $self->{len}
		1060	}
		1061
		1062	sub urxvt::line::r {
		1063	my ($self) = @_;
		1064
		1065	if (@_ > 1)
		1066	{
		1067	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1068	for $self->{beg} .. $self->{end};
		1069	}
		1070
		1071	if (defined wantarray) {
		1072	my $rend = [
		1073	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1074	];
		1075	$#$rend = $self->{len} - 1;
		1076	return $rend;
		1077	}
		1078
		1079	()
		1080	}
		1081
		1082	sub urxvt::line::beg { $_[0]{beg} }
		1083	sub urxvt::line::end { $_[0]{end} }
		1084	sub urxvt::line::l { $_[0]{len} }
		1085
		1086	sub urxvt::line::offset_of {
		1087	my ($self, $row, $col) = @_;
		1088
		1089	($row - $self->{beg}) * $self->{ncol} + $col
		1090	}
		1091
		1092	sub urxvt::line::coord_of {
		1093	my ($self, $offset) = @_;
		1094
		1095	use integer;
		1096
		1097	(
		1098	$offset / $self->{ncol} + $self->{beg},
		1099	$offset % $self->{ncol}
		1100	)
		1101	}
		1102
		1103	=item ($row, $col) = $line->coord_of ($offset)
583	=item $text = $term->special_encode $string	1104	=item $text = $term->special_encode $string
584		1105
585	Converts a perl string into the special encoding used by rxvt-unicode,	1106	Converts a perl string into the special encoding used by rxvt-unicode,
586	where one character corresponds to one screen cell. See	1107	where one character corresponds to one screen cell. See
587	C<< $term->ROW_t >> for details.	1108	C<< $term->ROW_t >> for details.
…		…
590		1111
591	Converts rxvt-unicodes text reprsentation into a perl string. See	1112	Converts rxvt-unicodes text reprsentation into a perl string. See
592	C<< $term->ROW_t >> for details.	1113	C<< $term->ROW_t >> for details.
593		1114
594	=back	1115	=back
		1116
		1117	=cut
		1118
		1119	package urxvt::popup;
		1120
		1121	=head2 The C<urxvt::popup> Class
		1122
		1123	=over 4
		1124
		1125	=cut
		1126
		1127	sub add_item {
		1128	my ($self, $item) = @_;
		1129
		1130	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1131	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1132	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1133
		1134	$item->{render} \|\|= sub { $_[0]{text} };
		1135
		1136	push @{ $self->{item} }, $item;
		1137	}
		1138
		1139	sub add_separator {
		1140	my ($self, $sep) = @_;
		1141
		1142	$sep \|\|= "═";
		1143
		1144	$self->add_item ({
		1145	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1146	text => "",
		1147	render => sub { $sep x $urxvt::TERM->ncol },
		1148	activate => sub { },
		1149	});
		1150	}
		1151
		1152	sub add_title {
		1153	my ($self, $title) = @_;
		1154
		1155	$self->add_item ({
		1156	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1157	text => $title,
		1158	activate => sub { },
		1159	});
		1160	}
		1161
		1162	sub add_button {
		1163	my ($self, $text, $cb) = @_;
		1164
		1165	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1166	}
		1167
		1168	sub add_toggle {
		1169	my ($self, $text, $cb, $value) = @_;
		1170
		1171	my $item; $item = {
		1172	type => "button",
		1173	text => " $text",
		1174	value => $value,
		1175	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1176	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1177	};
		1178
		1179	$self->add_item ($item);
		1180	}
		1181
		1182	sub show {
		1183	my ($self) = @_;
		1184
		1185	local $urxvt::popup::self = $self;
		1186
		1187	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1188	"--transient-for" => $self->{term}->parent,
		1189	"-pe" => "urxvt-popup")
		1190	or die "unable to create popup window\n";
		1191	}
		1192
		1193	sub DESTROY {
		1194	my ($self) = @_;
		1195
		1196	delete $self->{term}{_destroy}{$self};
		1197	$self->{term}->ungrab;
		1198	}
595		1199
596	=head2 The C<urxvt::timer> Class	1200	=head2 The C<urxvt::timer> Class
597		1201
598	This class implements timer watchers/events. Time is represented as a	1202	This class implements timer watchers/events. Time is represented as a
599	fractional number of seconds since the epoch. Example:	1203	fractional number of seconds since the epoch. Example:
…		…
701	This variable controls the verbosity level of the perl extension. Higher	1305	This variable controls the verbosity level of the perl extension. Higher
702	numbers indicate more verbose output.	1306	numbers indicate more verbose output.
703		1307
704	=over 4	1308	=over 4
705		1309
706	=item 0 - only fatal messages	1310	=item == 0 - fatal messages
707		1311
708	=item 3 - script loading and management	1312	=item >= 3 - script loading and management
709		1313
710	=item 10 - all events received	1314	=item >=10 - all events received
711		1315
712	=back	1316	=back
713		1317
714	=head1 AUTHOR	1318	=head1 AUTHOR
715		1319

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC vs. Revision 1.59 by root, Mon Jan 9 00:34:36 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC vs.
Revision 1.59 by root, Mon Jan 9 00:34:36 2006 UTC