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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC vs. Revision 1.65 by root, Mon Jan 9 19:25:57 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.65 by root, Mon Jan 9 19:25:57 2006 UTC