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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC vs.
Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
…		…
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection (enabled by default)
43		43
44	Miscellaneous selection modifications.	44	Intelligent selection. This extension tries to be more intelligent when
		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>.
		48
		49	It also offers the following bindable event:
45		50
46	=over 4	51	=over 4
47		52
48	=item rot13	53	=item rot13
49		54
…		…
51		56
52	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
53		58
54	=back	59	=back
55		60
		61	=item option-popup (enabled by default)
		62
		63	Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at
		64	runtime.
		65
56	=item digital-clock	66	=item digital-clock
		67
		68	Displays a digital clock using the built-in overlay.
		69
		70	=item mark-urls
		71
		72	Uses per-line display filtering (C<on_line_update>) to underline urls.
		73
		74	=item block-graphics-to-ascii
		75
		76	A not very useful example of filtering all text output to the terminal,
		77	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		78	similar-looking ascii character.
		79
		80	=item example-refresh-hooks
57		81
58	Displays a very simple digital clock in the upper right corner of the	82	Displays a very simple digital clock in the upper right corner of the
59	window. Illustrates overwriting the refresh callbacks to create your own	83	window. Illustrates overwriting the refresh callbacks to create your own
60	overlays or changes.	84	overlays or changes.
61		85
62	=item simple-overlay-clock
63
64	Displays a digital clock using the built-in overlay (colourful, useless).
65
66	=back	86	=back
67		87
68	=head2 General API Considerations	88	=head2 General API Considerations
69		89
70	All objects (such as terminals, time watchers etc.) are typical	90	All objects (such as terminals, time watchers etc.) are typical
71	reference-to-hash objects. The hash can be used to store anything you	91	reference-to-hash objects. The hash can be used to store anything you
72	like. All members starting with an underscore (such as C<_ptr> or	92	like. All members starting with an underscore (such as C<_ptr> or
73	C<_hook>) are reserved for internal uses and must not be accessed or	93	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
74	modified).	94	modified).
75		95
76	When objects are destroyed on the C++ side, the perl object hashes are	96	When objects are destroyed on the C++ side, the perl object hashes are
77	emptied, so its best to store related objects such as time watchers and	97	emptied, so its best to store related objects such as time watchers and
78	the like inside the terminal object so they get destroyed as soon as the	98	the like inside the terminal object so they get destroyed as soon as the
79	terminal is destroyed.	99	terminal is destroyed.
80		100
		101	Argument names also often indicate the type of a parameter. Here are some
		102	hints on what they mean:
		103
		104	=over 4
		105
		106	=item $text
		107
		108	Rxvt-unicodes special way of encoding text, where one "unicode" character
		109	always represents one screen cell. See L<row_t> for a discussion of this format.
		110
		111	=item $string
		112
		113	A perl text string, with an emphasis on I<text>. It can store all unicode
		114	characters and is to be distinguished with text encoded in a specific
		115	encoding (often locale-specific) and binary data.
		116
		117	=item $octets
		118
		119	Either binary data or - more common - a text string encoded in a
		120	locale-specific way.
		121
		122	=back
		123
81	=head2 Hooks	124	=head2 Hooks
82		125
83	The following subroutines can be declared in loaded scripts, and will be called	126	The following subroutines can be declared in extension files, and will be
84	whenever the relevant event happens.	127	called whenever the relevant event happens.
		128
		129	The first argument passed to them is an object private to each terminal
		130	and extension package. You can call all C<urxvt::term> methods on it, but
		131	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		132	object that is shared between all packages is stored in the C<term>
		133	member. It is, however, blessed intot he package of the extension script,
		134	so for all practical purposes you can treat an extension script as a class.
85		135
86	All of them must return a boolean value. If it is true, then the event	136	All of them must return a boolean value. If it is true, then the event
87	counts as being I<consumed>, and the invocation of other hooks is skipped,	137	counts as being I<consumed>, and the invocation of other hooks is skipped,
88	and the relevant action might not be carried out by the C++ code.	138	and the relevant action might not be carried out by the C++ code.
89		139
…		…
92	=over 4	142	=over 4
93		143
94	=item on_init $term	144	=item on_init $term
95		145
96	Called after a new terminal object has been initialized, but before	146	Called after a new terminal object has been initialized, but before
97	windows are created or the command gets run.	147	windows are created or the command gets run. Most methods are unsafe to
		148	call or deliver senseless data, as terminal size and other characteristics
		149	have not yet been determined. You can safely query and change resources,
		150	though.
98		151
99	=item on_reset $term	152	=item on_reset $term
100		153
101	Called after the screen is "reset" for any reason, such as resizing or	154	Called after the screen is "reset" for any reason, such as resizing or
102	control sequences. Here is where you can react on changes to size-related	155	control sequences. Here is where you can react on changes to size-related
…		…
122	requested from the server. The selection text can be queried and changed	175	requested from the server. The selection text can be queried and changed
123	by calling C<< $term->selection >>.	176	by calling C<< $term->selection >>.
124		177
125	Returning a true value aborts selection grabbing. It will still be hilighted.	178	Returning a true value aborts selection grabbing. It will still be hilighted.
126		179
127	=item on_focus_in $term	180	=item on_sel_extend $term
128		181
129	Called whenever the window gets the keyboard focus, before urxvt does	182	Called whenever the user tries to extend the selection (e.g. with a double
130	focus in processing.	183	click) and is either supposed to return false (normal operation), or
131		184	should extend the selection itelf and return true to suppress the built-in
132	=item on_focus_out $term
133
134	Called wheneever the window loses keyboard focus, before urxvt does focus
135	out processing.	185	processing.
		186
		187	See the F<selection> example extension.
136		188
137	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
138		190
139	Called whenever the view offset changes, i..e the user or program	191	Called whenever the view offset changes, i..e the user or program
140	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
151	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
152		204
153	=item on_tty_activity $term NYI	205	=item on_tty_activity $term NYI
154		206
155	Called whenever the program(s) running in the urxvt window send output.	207	Called whenever the program(s) running in the urxvt window send output.
		208
		209	=item on_osc_seq $term, $string
		210
		211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		212	operating system command) is processed. Cursor position and other state
		213	information is up-to-date when this happens. For interoperability, the
		214	string should start with the extension name and a colon, to distinguish
		215	it from commands for other extensions, and this might be enforced in the
		216	future.
		217
		218	Be careful not ever to trust (in a security sense) the data you receive,
		219	as its source can not easily be controleld (e-mail content, messages from
		220	other users on the same system etc.).
		221
		222	=item on_add_lines $term, $string
		223
		224	Called whenever text is about to be output, with the text as argument. You
		225	can filter/change and output the text yourself by returning a true value
		226	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		227	might be very slow, however, as your hook is called for B<all> text being
		228	output.
		229
		230	=item on_line_update $term, $row
		231
		232	Called whenever a line was updated or changed. Can be used to filter
		233	screen output (e.g. underline urls or other useless stuff). Only lines
		234	that are being shown will be filtered, and, due to performance reasons,
		235	not always immediately.
		236
		237	The row number is always the topmost row of the line if the line spans
		238	multiple rows.
		239
		240	Please note that, if you change the line, then the hook might get called
		241	later with the already-modified line (e.g. if unrelated parts change), so
		242	you cannot just toggle rendition bits, but only set them.
156		243
157	=item on_refresh_begin $term	244	=item on_refresh_begin $term
158		245
159	Called just before the screen gets redrawn. Can be used for overlay	246	Called just before the screen gets redrawn. Can be used for overlay
160	or similar effects by modify terminal contents in refresh_begin, and	247	or similar effects by modify terminal contents in refresh_begin, and
…		…
169		256
170	Called whenever the user presses a key combination that has a	257	Called whenever the user presses a key combination that has a
171	C<perl:string> action bound to it (see description of the B<keysym>	258	C<perl:string> action bound to it (see description of the B<keysym>
172	resource in the @@RXVT_NAME@@(1) manpage).	259	resource in the @@RXVT_NAME@@(1) manpage).
173		260
		261	=item on_focus_in $term
		262
		263	Called whenever the window gets the keyboard focus, before rxvt-unicode
		264	does focus in processing.
		265
		266	=item on_focus_out $term
		267
		268	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		269	focus out processing.
		270
		271	=item on_key_press $term, $event, $octets
		272
		273	=item on_key_release $term, $event
		274
		275	=item on_button_press $term, $event
		276
		277	=item on_button_release $term, $event
		278
		279	=item on_motion_notify $term, $event
		280
		281	=item on_map_notify $term, $event
		282
		283	=item on_unmap_notify $term, $event
		284
		285	Called whenever the corresponding X event is received for the terminal If
		286	the hook returns true, then the even will be ignored by rxvt-unicode.
		287
		288	The event is a hash with most values as named by Xlib (see the XEvent
		289	manpage), with the additional members C<row> and C<col>, which are the row
		290	and column under the mouse cursor.
		291
		292	C<on_key_press> additionally receives the string rxvt-unicode would
		293	output, if any, in locale-specific encoding.
		294
		295	subwindow.
		296
174	=back	297	=back
175		298
		299	=head2 Variables in the C<urxvt> Package
		300
		301	=over 4
		302
		303	=item $urxvt::TERM
		304
		305	The current terminal. This variable stores the current C<urxvt::term>
		306	object, whenever a callback/hook is executing.
		307
		308	=back
		309
176	=head2 Functions in the C<urxvt> Package	310	=head2 Functions in the C<urxvt> Package
177		311
178	=over 4	312	=over 4
		313
		314	=item $term = new urxvt [arg...]
		315
		316	Creates a new terminal, very similar as if you had started it with
		317	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		318	if the new instance couldn't be created. Returns C<undef> if the new
		319	instance didn't initialise perl, and the terminal object otherwise. The
		320	C<init> and C<start> hooks will be called during the call.
179		321
180	=item urxvt::fatal $errormessage	322	=item urxvt::fatal $errormessage
181		323
182	Fatally aborts execution with the given error message. Avoid at all	324	Fatally aborts execution with the given error message. Avoid at all
183	costs! The only time this is acceptable is when the terminal process	325	costs! The only time this is acceptable is when the terminal process
…		…
193	correct place, e.g. on stderr of the connecting urxvtc client.	335	correct place, e.g. on stderr of the connecting urxvtc client.
194		336
195	=item $time = urxvt::NOW	337	=item $time = urxvt::NOW
196		338
197	Returns the "current time" (as per the event loop).	339	Returns the "current time" (as per the event loop).
		340
		341	=item urxvt::CurrentTime
		342
		343	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		344	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		345	Button4Mask, Button5Mask, AnyModifier
		346
		347	Various constants for use in X calls and event processing.
		348
		349	=back
198		350
199	=head2 RENDITION	351	=head2 RENDITION
200		352
201	Rendition bitsets contain information about colour, font, font styles and	353	Rendition bitsets contain information about colour, font, font styles and
202	similar information for each screen cell.	354	similar information for each screen cell.
…		…
250		402
251	=cut	403	=cut
252		404
253	package urxvt;	405	package urxvt;
254		406
		407	use utf8;
255	use strict;	408	use strict;
		409	use Scalar::Util ();
		410	use List::Util ();
256		411
257	our $term;	412	our $VERSION = 1;
		413	our $TERM;
258	our @HOOKNAME;	414	our @HOOKNAME;
		415	our %OPTION;
259	our $LIBDIR;	416	our $LIBDIR;
260		417
261	BEGIN {	418	BEGIN {
262	urxvt->bootstrap;	419	urxvt->bootstrap;
263		420
…		…
287	my $name = $HOOKNAME[$htype];	444	my $name = $HOOKNAME[$htype];
288		445
289	my $ref = $pkg->can ("on_" . lc $name)	446	my $ref = $pkg->can ("on_" . lc $name)
290	or next;	447	or next;
291		448
292	$term->{_hook}[$htype]{$ref*1} = $ref;	449	$TERM->{_hook}[$htype]{$pkg} = $ref;
293	$hook_count[$htype]++	450	$hook_count[$htype]++
294	or set_should_invoke $htype, 1;	451	or set_should_invoke $htype, 1;
295	}	452	}
296	}	453	}
297		454
298	my $script_pkg = "script0000";	455	my $extension_pkg = "extension0000";
299	my %script_pkg;	456	my %extension_pkg;
300		457
301	# load a single script into its own package, once only	458	# load a single script into its own package, once only
302	sub script_package($) {	459	sub extension_package($) {
303	my ($path) = @_;	460	my ($path) = @_;
304		461
305	$script_pkg{$path} \|\|= do {	462	$extension_pkg{$path} \|\|= do {
306	my $pkg = "urxvt::" . ($script_pkg++);	463	my $pkg = "urxvt::" . ($extension_pkg++);
307		464
308	verbose 3, "loading script '$path' into package '$pkg'";	465	verbose 3, "loading extension '$path' into package '$pkg'";
309		466
310	open my $fh, "<:raw", $path	467	open my $fh, "<:raw", $path
311	or die "$path: $!";	468	or die "$path: $!";
312		469
313	my $source = "package $pkg; use strict; use utf8;\n"	470	my $source = "package $pkg; use strict; use utf8;\n"
		471	. "use base urxvt::term::proxy::;\n"
314	. "#line 1 \"$path\"\n{\n"	472	. "#line 1 \"$path\"\n{\n"
315	. (do { local $/; <$fh> })	473	. (do { local $/; <$fh> })
316	. "\n};\n1";	474	. "\n};\n1";
317		475
		476	$source =~ /(.*)/s and $source = $1; # untaint
		477
318	eval $source or die "$path: $@";	478	eval $source or die "$path: $@";
319		479
320	$pkg	480	$pkg
321	}	481	}
322	}	482	}
323		483
		484	our $retval; # return value for urxvt
		485
324	# called by the rxvt core	486	# called by the rxvt core
325	sub invoke {	487	sub invoke {
326	local $term = shift;	488	local $TERM = shift;
327	my $htype = shift;	489	my $htype = shift;
328		490
329	if ($htype == 0) { # INIT	491	if ($htype == 0) { # INIT
330	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	492	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		493
		494	my %want_ext;
331		495
332	for my $ext (split /:/, $term->resource ("perl_ext")) {	496	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		497	if ($_ eq "default") {
		498	$want_ext{$_}++ for qw(selection option-popup);
		499	} elsif (/^-(.*)$/) {
		500	delete $want_ext{$1};
		501	} else {
		502	$want_ext{$_}++;
		503	}
		504	}
		505
		506	for my $ext (keys %want_ext) {
333	my @files = grep -f $_, map "$_/$ext", @dirs;	507	my @files = grep -f $_, map "$_/$ext", @dirs;
334		508
335	if (@files) {	509	if (@files) {
336	register_package script_package $files[0];	510	register_package extension_package $files[0];
337	} else {	511	} else {
338	warn "perl extension '$ext' not found in perl library search path\n";	512	warn "perl extension '$ext' not found in perl library search path\n";
339	}	513	}
340	}	514	}
341		515
		516	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		517	warn $@ if $@;
		518	}
		519
		520	$retval = undef;
		521
		522	if (my $cb = $TERM->{_hook}[$htype]) {
		523	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		524	if $verbosity >= 10;
		525
		526	keys %$cb;
		527
		528	while (my ($pkg, $cb) = each %$cb) {
		529	eval {
		530	$retval = $cb->(
		531	$TERM->{_pkg}{$pkg} \|\|= do {
		532	my $proxy = bless { }, $pkg;
		533	Scalar::Util::weaken ($proxy->{term} = $TERM);
		534	$proxy
		535	},
		536	@_,
		537	) and last;
		538	};
		539	warn $@ if $@;#d#
		540	}
		541	}
		542
342	} elsif ($htype == 1) { # DESTROY	543	if ($htype == 1) { # DESTROY
		544	# remove hooks if unused
343	if (my $hook = $term->{_hook}) {	545	if (my $hook = $TERM->{_hook}) {
344	for my $htype (0..$#$hook) {	546	for my $htype (0..$#$hook) {
345	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	547	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
346	or set_should_invoke $htype, 0;	548	or set_should_invoke $htype, 0;
347	}	549	}
348	}	550	}
		551
		552	# clear package objects
		553	%$_ = () for values %{ $TERM->{_pkg} };
		554
		555	# clear package
		556	%$TERM = ();
349	}	557	}
350		558
351	my $cb = $term->{_hook}[$htype]	559	$retval
352	or return;	560	}
353		561
354	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	562	# urxvt::term::proxy
355	if $verbosity >= 10;
356		563
357	while (my ($k, $v) = each %$cb) {	564	sub urxvt::term::proxy::AUTOLOAD {
358	return 1 if $v->($term, @_);	565	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		566	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		567
		568	eval qq{
		569	sub $urxvt::term::proxy::AUTOLOAD {
		570	my \$proxy = shift;
		571	\$proxy->{term}->$1 (\@_)
		572	}
		573	1
		574	} or die "FATAL: unable to compile method forwarder: $@";
		575
		576	goto &$urxvt::term::proxy::AUTOLOAD;
		577	}
		578
		579	# urxvt::destroy_hook
		580
		581	sub urxvt::destroy_hook::DESTROY {
		582	${$_[0]}->();
		583	}
		584
		585	sub urxvt::destroy_hook(&) {
		586	bless \shift, urxvt::destroy_hook::
		587	}
		588
		589	package urxvt::anyevent;
		590
		591	=head2 The C<urxvt::anyevent> Class
		592
		593	The sole purpose of this class is to deliver an interface to the
		594	C<AnyEvent> module - any module using it will work inside urxvt without
		595	further work. The only exception is that you cannot wait on condition
		596	variables, but non-blocking condvar use is ok. What this means is that you
		597	cannot use blocking APIs, but the non-blocking variant should work.
		598
		599	=cut
		600
		601	our $VERSION = 1;
		602
		603	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		604	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		605
		606	sub timer {
		607	my ($class, %arg) = @_;
		608
		609	my $cb = $arg{cb};
		610
		611	urxvt::timer
		612	->new
		613	->start (urxvt::NOW + $arg{after})
		614	->cb (sub {
		615	$_[0]->stop; # need to cancel manually
		616	$cb->();
		617	})
		618	}
		619
		620	sub io {
		621	my ($class, %arg) = @_;
		622
		623	my $cb = $arg{cb};
		624
		625	bless [$arg{fh}, urxvt::iow
		626	->new
		627	->fd (fileno $arg{fh})
		628	->events (($arg{poll} =~ /r/ ? 1 : 0)
		629	\| ($arg{poll} =~ /w/ ? 2 : 0))
		630	->start
		631	->cb (sub {
		632	$cb->(($_[1] & 1 ? 'r' : '')
		633	. ($_[1] & 2 ? 'w' : ''));
		634	})],
		635	urxvt::anyevent::
		636	}
		637
		638	sub DESTROY {
		639	$_[0][1]->stop;
		640	}
		641
		642	sub condvar {
		643	bless \my $flag, urxvt::anyevent::condvar::
		644	}
		645
		646	sub urxvt::anyevent::condvar::broadcast {
		647	${$_[0]}++;
		648	}
		649
		650	sub urxvt::anyevent::condvar::wait {
		651	unless (${$_[0]}) {
		652	require Carp;
		653	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
359	}	654	}
360
361	0
362	}	655	}
363		656
364	=back	657	package urxvt::term;
365		658
366	=head2 The C<urxvt::term> Class	659	=head2 The C<urxvt::term> Class
367		660
368	=over 4	661	=over 4
		662
		663	=item $term->destroy
		664
		665	Destroy the terminal object (close the window, free resources etc.).
		666
		667	=item $isset = $term->option ($optval[, $set])
		668
		669	Returns true if the option specified by C<$optval> is enabled, and
		670	optionally change it. All option values are stored by name in the hash
		671	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		672
		673	Here is a a likely non-exhaustive list of option names, please see the
		674	source file F</src/optinc.h> to see the actual list:
		675
		676	borderLess console cursorBlink cursorUnderline hold iconic insecure
		677	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		678	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		679	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		680	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		681	tripleclickwords utmpInhibit visualBell
369		682
370	=item $value = $term->resource ($name[, $newval])	683	=item $value = $term->resource ($name[, $newval])
371		684
372	Returns the current resource value associated with a given name and	685	Returns the current resource value associated with a given name and
373	optionally sets a new value. Setting values is most useful in the C<init>	686	optionally sets a new value. Setting values is most useful in the C<init>
…		…
383		696
384	Please note that resource strings will currently only be freed when the	697	Please note that resource strings will currently only be freed when the
385	terminal is destroyed, so changing options frequently will eat memory.	698	terminal is destroyed, so changing options frequently will eat memory.
386		699
387	Here is a a likely non-exhaustive list of resource names, not all of which	700	Here is a a likely non-exhaustive list of resource names, not all of which
388	are supported in every build, please see the source to see the actual	701	are supported in every build, please see the source file F</src/rsinc.h>
389	list:	702	to see the actual list:
390		703
391	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	704	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
392	borderLess color cursorBlink cursorUnderline cutchars delete_key	705	borderLess color cursorBlink cursorUnderline cutchars delete_key
393	display_name embed ext_bwidth fade font geometry hold iconName	706	display_name embed ext_bwidth fade font geometry hold iconName
394	imFont imLocale inputMethod insecure int_bwidth intensityStyles	707	imFont imLocale inputMethod insecure int_bwidth intensityStyles
395	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	708	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
396	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	709	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
397	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	710	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
398	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	711	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
399	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	712	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
400	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	713	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
401	shade term_name title transparent transparent_all tripleclickwords	714	shade term_name title transparent transparent_all tripleclickwords
402	utmpInhibit visualBell	715	utmpInhibit visualBell
403		716
404	=cut	717	=cut
405		718
406	sub urxvt::term::resource($$;$) {	719	sub resource($$;$) {
407	my ($self, $name) = (shift, shift);	720	my ($self, $name) = (shift, shift);
408	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	721	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
409	goto &urxvt::term::_resource;	722	&urxvt::term::_resource
410	}	723	}
		724
		725	=item $rend = $term->rstyle ([$new_rstyle])
		726
		727	Return and optionally change the current rendition. Text that is output by
		728	the terminal application will use this style.
		729
		730	=item ($row, $col) = $term->screen_cur ([$row, $col])
		731
		732	Return the current coordinates of the text cursor position and optionally
		733	set it (which is usually bad as applications don't expect that).
411		734
412	=item ($row, $col) = $term->selection_mark ([$row, $col])	735	=item ($row, $col) = $term->selection_mark ([$row, $col])
413		736
414	=item ($row, $col) = $term->selection_beg ([$row, $col])	737	=item ($row, $col) = $term->selection_beg ([$row, $col])
415		738
…		…
425		748
426	=item $oldtext = $term->selection ([$newtext])	749	=item $oldtext = $term->selection ([$newtext])
427		750
428	Return the current selection text and optionally replace it by C<$newtext>.	751	Return the current selection text and optionally replace it by C<$newtext>.
429		752
430	=item $term->scr_overlay ($x, $y, $text)	753	#=item $term->overlay ($x, $y, $text)
431		754	#
432	Create a simple multi-line overlay box. See the next method for details.	755	#Create a simple multi-line overlay box. See the next method for details.
		756	#
		757	#=cut
		758	#
		759	#sub urxvt::term::scr_overlay {
		760	# my ($self, $x, $y, $text) = @_;
		761	#
		762	# my @lines = split /\n/, $text;
		763	#
		764	# my $w = 0;
		765	# for (map $self->strwidth ($_), @lines) {
		766	# $w = $_ if $w < $_;
		767	# }
		768	#
		769	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
		770	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
		771	#}
		772
		773	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
		774
		775	Create a new (empty) overlay at the given position with the given
		776	width/height. C<$rstyle> defines the initial rendition style
		777	(default: C<OVERLAY_RSTYLE>).
		778
		779	If C<$border> is C<2> (default), then a decorative border will be put
		780	around the box.
		781
		782	If either C<$x> or C<$y> is negative, then this is counted from the
		783	right/bottom side, respectively.
		784
		785	This method returns an urxvt::overlay object. The overlay will be visible
		786	as long as the perl object is referenced.
		787
		788	The methods currently supported on C<urxvt::overlay> objects are:
		789
		790	=over 4
		791
		792	=item $overlay->set ($x, $y, $text, $rend)
		793
		794	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		795	text in rxvt-unicode's special encoding and an array of rendition values
		796	at a specific position inside the overlay.
		797
		798	=item $overlay->hide
		799
		800	If visible, hide the overlay, but do not destroy it.
		801
		802	=item $overlay->show
		803
		804	If hidden, display the overlay again.
		805
		806	=back
		807
		808	=item $popup = $term->popup ($event)
		809
		810	Creates a new C<urxvt::popup> object that implements a popup menu. The
		811	C<$event> I<must> be the event causing the menu to pop up (a button event,
		812	currently).
433		813
434	=cut	814	=cut
435		815
436	sub urxvt::term::scr_overlay {	816	sub popup {
437	my ($self, $x, $y, $text) = @_;	817	my ($self, $event) = @_;
438		818
439	my @lines = split /\n/, $text;	819	$self->grab ($event->{time}, 1)
		820	or return;
440		821
441	my $w = 0;	822	my $popup = bless {
442	for (map $self->strwidth ($_), @lines) {	823	term => $self,
443	$w = $_ if $w < $_;	824	event => $event,
444	}	825	}, urxvt::popup::;
445		826
446	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	827	Scalar::Util::weaken $popup->{term};
447	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
448	}
449		828
450	=item $term->scr_overlay_new ($x, $y, $width, $height)	829	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		830	Scalar::Util::weaken $self->{_destroy}{$popup};
451		831
452	Create a new (empty) overlay at the given position with the given	832	$popup
453	width/height. A border will be put around the box. If either C<$x> or	833	}
454	C<$y> is negative, then this is counted from the right/bottom side,
455	respectively.
456		834
457	=item $term->scr_overlay_off
458
459	Switch the overlay off again.
460
461	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)
462
463	Put a single character (specified numerically) at the given overlay
464	position.
465
466	=item $term->scr_overlay_set ($x, $y, $text)
467
468	Write a string at the given position into the overlay.
469
470	=item $cellwidth = $term->strwidth $string	835	=item $cellwidth = $term->strwidth ($string)
471		836
472	Returns the number of screen-cells this string would need. Correctly	837	Returns the number of screen-cells this string would need. Correctly
473	accounts for wide and combining characters.	838	accounts for wide and combining characters.
474		839
475	=item $octets = $term->locale_encode $string	840	=item $octets = $term->locale_encode ($string)
476		841
477	Convert the given text string into the corresponding locale encoding.	842	Convert the given text string into the corresponding locale encoding.
478		843
479	=item $string = $term->locale_decode $octets	844	=item $string = $term->locale_decode ($octets)
480		845
481	Convert the given locale-encoded octets into a perl string.	846	Convert the given locale-encoded octets into a perl string.
		847
		848	=item $term->scr_add_lines ($string)
		849
		850	Write the given text string to the screen, as if output by the application
		851	running inside the terminal. It may not contain command sequences (escape
		852	codes), but is free to use line feeds, carriage returns and tabs. The
		853	string is a normal text string, not in locale-dependent encoding.
		854
		855	Normally its not a good idea to use this function, as programs might be
		856	confused by changes in cursor position or scrolling. Its useful inside a
		857	C<on_add_lines> hook, though.
		858
		859	=item $term->cmd_parse ($octets)
		860
		861	Similar to C<scr_add_lines>, but the argument must be in the
		862	locale-specific encoding of the terminal and can contain command sequences
		863	(escape codes) that will be interpreted.
482		864
483	=item $term->tt_write ($octets)	865	=item $term->tt_write ($octets)
484		866
485	Write the octets given in C<$data> to the tty (i.e. as program input). To	867	Write the octets given in C<$data> to the tty (i.e. as program input). To
486	pass characters instead of octets, you should convert your strings first	868	pass characters instead of octets, you should convert your strings first
487	to the locale-specific encoding using C<< $term->locale_encode >>.	869	to the locale-specific encoding using C<< $term->locale_encode >>.
488		870
		871	=item $windowid = $term->parent
		872
		873	Return the window id of the toplevel window.
		874
		875	=item $windowid = $term->vt
		876
		877	Return the window id of the terminal window.
		878
		879	=item $window_width = $term->width
		880
		881	=item $window_height = $term->height
		882
		883	=item $font_width = $term->fwidth
		884
		885	=item $font_height = $term->fheight
		886
		887	=item $font_ascent = $term->fbase
		888
489	=item $nrow = $term->nrow	889	=item $terminal_rows = $term->nrow
490		890
491	=item $ncol = $term->ncol	891	=item $terminal_columns = $term->ncol
492		892
493	Return the number of rows/columns of the terminal window (i.e. as	893	=item $has_focus = $term->focus
494	specified by C<-geometry>, excluding any scrollback).
495		894
496	=item $nsaved = $term->nsaved	895	=item $is_mapped = $term->mapped
497		896
498	Returns the number of lines in the scrollback buffer.	897	=item $max_scrollback = $term->saveLines
		898
		899	=item $nrow_plus_saveLines = $term->total_rows
		900
		901	=item $lines_in_scrollback = $term->nsaved
		902
		903	Return various integers describing terminal characteristics.
		904
		905	=item $modifiermask = $term->ModLevel3Mask
		906
		907	=item $modifiermask = $term->ModMetaMask
		908
		909	=item $modifiermask = $term->ModNumLockMask
		910
		911	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		912	AltGr), the meta key (often Alt) and the num lock key, if applicable.
499		913
500	=item $view_start = $term->view_start ([$newvalue])	914	=item $view_start = $term->view_start ([$newvalue])
501		915
502	Returns the negative row number of the topmost line. Minimum value is	916	Returns the negative row number of the topmost line. Minimum value is
503	C<0>, which displays the normal terminal contents. Larger values scroll	917	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
514	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	928	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
515		929
516	Returns the text of the entire row with number C<$row_number>. Row C<0>	930	Returns the text of the entire row with number C<$row_number>. Row C<0>
517	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	931	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
518	terminal line. The scrollback buffer starts at line C<-1> and extends to	932	terminal line. The scrollback buffer starts at line C<-1> and extends to
519	line C<< -$term->nsaved >>.	933	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		934	is requested.
520		935
521	If C<$new_text> is specified, it will replace characters in the current	936	If C<$new_text> is specified, it will replace characters in the current
522	line, starting at column C<$start_col> (default C<0>), which is useful	937	line, starting at column C<$start_col> (default C<0>), which is useful
523	to replace only parts of a line. The font index in the rendition will	938	to replace only parts of a line. The font index in the rendition will
524	automatically be updated.	939	automatically be updated.
…		…
546		961
547	See the section on RENDITION, above.	962	See the section on RENDITION, above.
548		963
549	=item $length = $term->ROW_l ($row_number[, $new_length])	964	=item $length = $term->ROW_l ($row_number[, $new_length])
550		965
551	Returns the number of screen cells that are in use ("the line length"). If	966	Returns the number of screen cells that are in use ("the line
552	it is C<-1>, then the line is part of a multiple-row logical "line", which	967	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
553	means all characters are in use and it is continued on the next row.	968	line is joined with the following one.
554		969
		970	=item $bool = $term->is_longer ($row_number)
		971
		972	Returns true if the row is part of a multiple-row logical "line" (i.e.
		973	joined with the following row), which means all characters are in use
		974	and it is continued on the next row (and possibly a continuation of the
		975	previous row(s)).
		976
		977	=item $line = $term->line ($row_number)
		978
		979	Create and return a new C<urxvt::line> object that stores information
		980	about the logical line that row C<$row_number> is part of. It supports the
		981	following methods:
		982
		983	=over 4
		984
		985	=item $text = $line->t ([$new_text])
		986
		987	Returns or replaces the full text of the line, similar to C<ROW_t>
		988
		989	=item $rend = $line->r ([$new_rend])
		990
		991	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		992
		993	=item $length = $line->l
		994
		995	Returns the length of the line in cells, similar to C<ROW_l>.
		996
		997	=item $rownum = $line->beg
		998
		999	=item $rownum = $line->end
		1000
		1001	Return the row number of the first/last row of the line, respectively.
		1002
		1003	=item $offset = $line->offset_of ($row, $col)
		1004
		1005	Returns the character offset of the given row\|col pair within the logical
		1006	line.
		1007
		1008	=item ($row, $col) = $line->coord_of ($offset)
		1009
		1010	Translates a string offset into terminal coordinates again.
		1011
		1012	=back
		1013
		1014	=cut
		1015
		1016	sub line {
		1017	my ($self, $row) = @_;
		1018
		1019	my $maxrow = $self->nrow - 1;
		1020
		1021	my ($beg, $end) = ($row, $row);
		1022
		1023	--$beg while $self->ROW_is_longer ($beg - 1);
		1024	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1025
		1026	bless {
		1027	term => $self,
		1028	beg => $beg,
		1029	end => $end,
		1030	ncol => $self->ncol,
		1031	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1032	}, urxvt::line::
		1033	}
		1034
		1035	sub urxvt::line::t {
		1036	my ($self) = @_;
		1037
		1038	if (@_ > 1)
		1039	{
		1040	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1041	for $self->{beg} .. $self->{end};
		1042	}
		1043
		1044	defined wantarray &&
		1045	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1046	0, $self->{len}
		1047	}
		1048
		1049	sub urxvt::line::r {
		1050	my ($self) = @_;
		1051
		1052	if (@_ > 1)
		1053	{
		1054	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1055	for $self->{beg} .. $self->{end};
		1056	}
		1057
		1058	if (defined wantarray) {
		1059	my $rend = [
		1060	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1061	];
		1062	$#$rend = $self->{len} - 1;
		1063	return $rend;
		1064	}
		1065
		1066	()
		1067	}
		1068
		1069	sub urxvt::line::beg { $_[0]{beg} }
		1070	sub urxvt::line::end { $_[0]{end} }
		1071	sub urxvt::line::l { $_[0]{len} }
		1072
		1073	sub urxvt::line::offset_of {
		1074	my ($self, $row, $col) = @_;
		1075
		1076	($row - $self->{beg}) * $self->{ncol} + $col
		1077	}
		1078
		1079	sub urxvt::line::coord_of {
		1080	my ($self, $offset) = @_;
		1081
		1082	use integer;
		1083
		1084	(
		1085	$offset / $self->{ncol} + $self->{beg},
		1086	$offset % $self->{ncol}
		1087	)
		1088	}
		1089
		1090	=item ($row, $col) = $line->coord_of ($offset)
555	=item $text = $term->special_encode $string	1091	=item $text = $term->special_encode $string
556		1092
557	Converts a perl string into the special encoding used by rxvt-unicode,	1093	Converts a perl string into the special encoding used by rxvt-unicode,
558	where one character corresponds to one screen cell. See	1094	where one character corresponds to one screen cell. See
559	C<< $term->ROW_t >> for details.	1095	C<< $term->ROW_t >> for details.
…		…
563	Converts rxvt-unicodes text reprsentation into a perl string. See	1099	Converts rxvt-unicodes text reprsentation into a perl string. See
564	C<< $term->ROW_t >> for details.	1100	C<< $term->ROW_t >> for details.
565		1101
566	=back	1102	=back
567		1103
		1104	=cut
		1105
		1106	package urxvt::popup;
		1107
		1108	=head2 The C<urxvt::popup> Class
		1109
		1110	=over 4
		1111
		1112	=cut
		1113
		1114	sub add_item {
		1115	my ($self, $item) = @_;
		1116
		1117	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1118	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1119	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1120
		1121	$item->{render} \|\|= sub { $_[0]{text} };
		1122
		1123	push @{ $self->{item} }, $item;
		1124	}
		1125
		1126	sub add_separator {
		1127	my ($self, $sep) = @_;
		1128
		1129	$sep \|\|= "═";
		1130
		1131	$self->add_item ({
		1132	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1133	text => "",
		1134	render => sub { $sep x $urxvt::TERM->ncol },
		1135	activate => sub { },
		1136	});
		1137	}
		1138
		1139	sub add_title {
		1140	my ($self, $title) = @_;
		1141
		1142	$self->add_item ({
		1143	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1144	text => $title,
		1145	activate => sub { },
		1146	});
		1147	}
		1148
		1149	sub add_button {
		1150	my ($self, $text, $cb) = @_;
		1151
		1152	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1153	}
		1154
		1155	sub add_toggle {
		1156	my ($self, $text, $cb, $value) = @_;
		1157
		1158	my $item; $item = {
		1159	type => "button",
		1160	text => " $text",
		1161	value => $value,
		1162	render => sub { ($item->{value} ? "* " : " ") . $text },
		1163	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1164	};
		1165
		1166	$self->add_item ($item);
		1167	}
		1168
		1169	sub show {
		1170	my ($self) = @_;
		1171
		1172	local $urxvt::popup::self = $self;
		1173
		1174	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1175	"--transient-for" => $self->{term}->parent,
		1176	"-pe" => "urxvt-popup")
		1177	or die "unable to create popup window\n";
		1178	}
		1179
		1180	sub DESTROY {
		1181	my ($self) = @_;
		1182
		1183	$self->{term}->ungrab;
		1184	}
		1185
568	=head2 The C<urxvt::timer> Class	1186	=head2 The C<urxvt::timer> Class
569		1187
570	This class implements timer watchers/events. Time is represented as a	1188	This class implements timer watchers/events. Time is represented as a
571	fractional number of seconds since the epoch. Example:	1189	fractional number of seconds since the epoch. Example:
572		1190
573	# create a digital clock display in upper right corner	1191	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
574	$term->{timer} = urxvt::timer	1192	$term->{timer} = urxvt::timer
575	->new	1193	->new
576	->start (urxvt::NOW)	1194	->interval (1)
577	->cb (sub {	1195	->cb (sub {
578	my ($timer) = @_;
579	my $time = $timer->at;
580	$timer->start ($time + 1);
581	$self->scr_overlay (-1, 0,	1196	$term->{overlay}->set (0, 0,
582	POSIX::strftime "%H:%M:%S", localtime $time);	1197	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
583	});	1198	});
584		1199
585	=over 4	1200	=over 4
586		1201
587	=item $timer = new urxvt::timer	1202	=item $timer = new urxvt::timer
588		1203
589	Create a new timer object in stopped state.	1204	Create a new timer object in started state. It is scheduled to fire
		1205	immediately.
590		1206
591	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1207	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
592		1208
593	Set the callback to be called when the timer triggers.	1209	Set the callback to be called when the timer triggers.
594		1210
…		…
597	Return the time this watcher will fire next.	1213	Return the time this watcher will fire next.
598		1214
599	=item $timer = $timer->set ($tstamp)	1215	=item $timer = $timer->set ($tstamp)
600		1216
601	Set the time the event is generated to $tstamp.	1217	Set the time the event is generated to $tstamp.
		1218
		1219	=item $timer = $timer->interval ($interval)
		1220
		1221	Normally (and when C<$interval> is C<0>), the timer will automatically
		1222	stop after it has fired once. If C<$interval> is non-zero, then the timer
		1223	is automatically rescheduled at the given intervals.
602		1224
603	=item $timer = $timer->start	1225	=item $timer = $timer->start
604		1226
605	Start the timer.	1227	Start the timer.
606		1228
…		…
669	This variable controls the verbosity level of the perl extension. Higher	1291	This variable controls the verbosity level of the perl extension. Higher
670	numbers indicate more verbose output.	1292	numbers indicate more verbose output.
671		1293
672	=over 4	1294	=over 4
673		1295
674	=item 0 - only fatal messages	1296	=item =0 - only fatal messages
675		1297
676	=item 3 - script loading and management	1298	=item =3 - script loading and management
677		1299
678	=item 10 - all events received	1300	=item =10 - all events received
679		1301
680	=back	1302	=back
681		1303
682	=head1 AUTHOR	1304	=head1 AUTHOR
683		1305

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC vs. Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC vs.
Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC