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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC vs.
Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
…		…
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	Intelligent selection. This extension tries to be more intelligent when
45	the user extends selections (double-click). Right now, it tries to select	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,	46	urls and complete shell-quoted arguments, which is very convenient, too,
47	if your F<ls> supports C<--quoting-style=shell>.	47	if your F<ls> supports C<--quoting-style=shell>.
…		…
56		56
57	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
58		58
59	=back	59	=back
60		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
61	=item digital-clock	71	=item digital-clock
62		72
63	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.
64		84
65	=item example-refresh-hooks	85	=item example-refresh-hooks
66		86
67	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
68	window. Illustrates overwriting the refresh callbacks to create your own	88	window. Illustrates overwriting the refresh callbacks to create your own
…		…
81	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
82	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
83	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
84	terminal is destroyed.	104	terminal is destroyed.
85		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
86	=head2 Hooks	129	=head2 Hooks
87		130
88	The following subroutines can be declared in loaded scripts, and will be	131	The following subroutines can be declared in extension files, and will be
89	called whenever the relevant event happens.	132	called whenever the relevant event happens.
90		133
91	The first argument passed to them is an object private to each terminal	134	The first argument passed to them is an object private to each terminal
92	and extension package. You can call all C<urxvt::term> methods on it, but	135	and extension package. You can call all C<urxvt::term> methods on it, but
93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>	136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94	object that is shared between all packages is stored in the C<term>	137	object that is shared between all packages is stored in the C<term>
95	member.	138	member. It is, however, blessed intot he package of the extension script,
		139	so for all practical purposes you can treat an extension script as a class.
96		140
97	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
98	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,
99	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.
100		144
…		…
103	=over 4	147	=over 4
104		148
105	=item on_init $term	149	=item on_init $term
106		150
107	Called after a new terminal object has been initialized, but before	151	Called after a new terminal object has been initialized, but before
108	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.
109		156
110	=item on_reset $term	157	=item on_reset $term
111		158
112	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
113	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
…		…
142	should extend the selection itelf and return true to suppress the built-in	189	should extend the selection itelf and return true to suppress the built-in
143	processing.	190	processing.
144		191
145	See the F<selection> example extension.	192	See the F<selection> example extension.
146		193
147	=item on_focus_in $term
148
149	Called whenever the window gets the keyboard focus, before urxvt does
150	focus in processing.
151
152	=item on_focus_out $term
153
154	Called wheneever the window loses keyboard focus, before urxvt does focus
155	out processing.
156
157	=item on_view_change $term, $offset	194	=item on_view_change $term, $offset
158		195
159	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
160	scrolls. Offset C<0> means display the normal terminal, positive values	197	scrolls. Offset C<0> means display the normal terminal, positive values
161	show this many lines of scrollback.	198	show this many lines of scrollback.
…		…
168		205
169	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,
170	$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
171	number of lines that will be in the scrollback buffer.	208	number of lines that will be in the scrollback buffer.
172		209
173	=item on_tty_activity $term NYI	210	=item on_osc_seq $term, $string
174		211
175	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.
176		244
177	=item on_refresh_begin $term	245	=item on_refresh_begin $term
178		246
179	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
180	or similar effects by modify terminal contents in refresh_begin, and	248	or similar effects by modify terminal contents in refresh_begin, and
…		…
189		257
190	Called whenever the user presses a key combination that has a	258	Called whenever the user presses a key combination that has a
191	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>
192	resource in the @@RXVT_NAME@@(1) manpage).	260	resource in the @@RXVT_NAME@@(1) manpage).
193		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
194	=back	298	=back
195		299
196	=head2 Variables in the C<urxvt> Package	300	=head2 Variables in the C<urxvt> Package
197		301
198	=over 4	302	=over 4
199		303
200	=item $urxvt::TERM	304	=item $urxvt::TERM
201		305
202	The current terminal. Whenever a callback/Hook is bein executed, this	306	The current terminal. This variable stores the current C<urxvt::term>
203	variable stores the current C<urxvt::term> object.	307	object, whenever a callback/hook is executing.
204		308
205	=back	309	=back
206		310
207	=head2 Functions in the C<urxvt> Package	311	=head2 Functions in the C<urxvt> Package
208		312
209	=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.
210		322
211	=item urxvt::fatal $errormessage	323	=item urxvt::fatal $errormessage
212		324
213	Fatally aborts execution with the given error message. Avoid at all	325	Fatally aborts execution with the given error message. Avoid at all
214	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
…		…
221	that calls this function.	333	that calls this function.
222		334
223	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
224	correct place, e.g. on stderr of the connecting urxvtc client.	336	correct place, e.g. on stderr of the connecting urxvtc client.
225		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
226	=item $time = urxvt::NOW	344	=item $time = urxvt::NOW
227		345
228	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.
229		355
230	=back	356	=back
231		357
232	=head2 RENDITION	358	=head2 RENDITION
233		359
…		…
283		409
284	=cut	410	=cut
285		411
286	package urxvt;	412	package urxvt;
287		413
		414	use utf8;
288	use strict;	415	use strict;
289	use Scalar::Util ();	416	use Scalar::Util ();
		417	use List::Util ();
290		418
		419	our $VERSION = 1;
291	our $TERM;	420	our $TERM;
292	our @HOOKNAME;	421	our @HOOKNAME;
		422	our %OPTION;
293	our $LIBDIR;	423	our $LIBDIR;
294		424
295	BEGIN {	425	BEGIN {
296	urxvt->bootstrap;	426	urxvt->bootstrap;
297		427
…		…
300	my $msg = join "", @_;	430	my $msg = join "", @_;
301	$msg .= "\n"	431	$msg .= "\n"
302	unless $msg =~ /\n$/;	432	unless $msg =~ /\n$/;
303	urxvt::warn ($msg);	433	urxvt::warn ($msg);
304	};	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";
305	}	440	}
306		441
307	my @hook_count;	442	my @hook_count;
308	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
309		444
310	sub verbose {	445	sub verbose {
311	my ($level, $msg) = @_;	446	my ($level, $msg) = @_;
312	warn "$msg\n" if $level <= $verbosity;	447	warn "$msg\n" if $level <= $verbosity;
313	}	448	}
314		449
315	# find on_xxx subs in the package and register them	450	my $extension_pkg = "extension0000";
316	# as hooks	451	my %extension_pkg;
317	sub register_package($) {
318	my ($pkg) = @_;
319
320	for my $htype (0.. $#HOOKNAME) {
321	my $name = $HOOKNAME[$htype];
322
323	my $ref = $pkg->can ("on_" . lc $name)
324	or next;
325
326	$TERM->{_hook}[$htype]{$pkg} = $ref;
327	$hook_count[$htype]++
328	or set_should_invoke $htype, 1;
329	}
330	}
331
332	my $script_pkg = "script0000";
333	my %script_pkg;
334		452
335	# load a single script into its own package, once only	453	# load a single script into its own package, once only
336	sub script_package($) {	454	sub extension_package($) {
337	my ($path) = @_;	455	my ($path) = @_;
338		456
339	$script_pkg{$path} \|\|= do {	457	$extension_pkg{$path} \|\|= do {
340	my $pkg = "urxvt::" . ($script_pkg++);	458	my $pkg = "urxvt::" . ($extension_pkg++);
341		459
342	verbose 3, "loading script '$path' into package '$pkg'";	460	verbose 3, "loading extension '$path' into package '$pkg'";
343		461
344	open my $fh, "<:raw", $path	462	open my $fh, "<:raw", $path
345	or die "$path: $!";	463	or die "$path: $!";
346		464
347	my $source = "package $pkg; use strict; use utf8;\n"	465	my $source = untaint "package $pkg; use strict; use utf8;\n"
		466	. "use base urxvt::term::proxy::;\n"
348	. "#line 1 \"$path\"\n{\n"	467	. "#line 1 \"$path\"\n{\n"
349	. (do { local $/; <$fh> })	468	. (do { local $/; <$fh> })
350	. "\n};\n1";	469	. "\n};\n1";
351		470
352	eval $source or die "$path: $@";	471	eval $source or die "$path: $@";
353		472
354	$pkg	473	$pkg
355	}	474	}
356	}	475	}
		476
		477	our $retval; # return value for urxvt
357		478
358	# called by the rxvt core	479	# called by the rxvt core
359	sub invoke {	480	sub invoke {
360	local $TERM = shift;	481	local $TERM = shift;
361	my $htype = shift;	482	my $htype = shift;
362		483
363	if ($htype == 0) { # INIT	484	if ($htype == 0) { # INIT
364	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	485	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		486
		487	my %ext_arg;
365		488
366	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	489	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		490	if ($_ eq "default") {
		491	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup);
		492	} elsif (/^-(.*)$/) {
		493	delete $ext_arg{$1};
		494	} elsif (/^([^<]+)<(.*)>$/) {
		495	push @{ $ext_arg{$1} }, $2;
		496	} else {
		497	$ext_arg{$_} \|\|= [];
		498	}
		499	}
		500
		501	while (my ($ext, $argv) = each %ext_arg) {
367	my @files = grep -f $_, map "$_/$ext", @dirs;	502	my @files = grep -f $_, map "$_/$ext", @dirs;
368		503
369	if (@files) {	504	if (@files) {
370	register_package script_package $files[0];	505	$TERM->register_package (extension_package $files[0], $argv);
371	} else {	506	} else {
372	warn "perl extension '$ext' not found in perl library search path\n";	507	warn "perl extension '$ext' not found in perl library search path\n";
373	}	508	}
374	}	509	}
375		510
		511	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		512	warn $@ if $@;
		513	}
		514
		515	$retval = undef;
		516
		517	if (my $cb = $TERM->{_hook}[$htype]) {
		518	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		519	if $verbosity >= 10;
		520
		521	keys %$cb;
		522
		523	while (my ($pkg, $cb) = each %$cb) {
		524	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
		525	and last;
		526
		527	if ($@) {
		528	$TERM->ungrab; # better to lose the grab than the session
		529	warn $@;
		530	}
		531	}
		532	}
		533
376	} elsif ($htype == 1) { # DESTROY	534	if ($htype == 1) { # DESTROY
		535	# remove hooks if unused
377	if (my $hook = $TERM->{_hook}) {	536	if (my $hook = $TERM->{_hook}) {
378	for my $htype (0..$#$hook) {	537	for my $htype (0..$#$hook) {
379	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	538	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
380	or set_should_invoke $htype, 0;	539	or set_should_invoke $htype, 0;
381	}	540	}
382	}	541	}
		542
		543	# clear package objects
		544	%$_ = () for values %{ $TERM->{_pkg} };
		545
		546	# clear package
		547	%$TERM = ();
383	}	548	}
384		549
385	my $cb = $TERM->{_hook}[$htype]	550	$retval
386	or return;
387
388	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
389	if $verbosity >= 10;
390
391	keys %$cb;
392
393	while (my ($pkg, $cb) = each %$cb) {
394	return 1
395	if $cb->(
396	$TERM->{$pkg} \|\|= do {
397	my $proxy = bless { }, urxvt::term::proxy::;
398	Scalar::Util::weaken ($proxy->{term} = $TERM);
399	$proxy
400	},
401	@_,
402	);
403	}
404
405	0
406	}	551	}
		552
		553	# urxvt::term::proxy
407		554
408	sub urxvt::term::proxy::AUTOLOAD {	555	sub urxvt::term::proxy::AUTOLOAD {
409	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	556	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
410	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	557	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
411		558
…		…
418	} or die "FATAL: unable to compile method forwarder: $@";	565	} or die "FATAL: unable to compile method forwarder: $@";
419		566
420	goto &$urxvt::term::proxy::AUTOLOAD;	567	goto &$urxvt::term::proxy::AUTOLOAD;
421	}	568	}
422		569
		570	sub urxvt::term::proxy::DESTROY {
		571	# nop
		572	}
		573
		574	# urxvt::destroy_hook
		575
		576	sub urxvt::destroy_hook::DESTROY {
		577	${$_[0]}->();
		578	}
		579
		580	sub urxvt::destroy_hook(&) {
		581	bless \shift, urxvt::destroy_hook::
		582	}
		583
		584	package urxvt::anyevent;
		585
		586	=head2 The C<urxvt::anyevent> Class
		587
		588	The sole purpose of this class is to deliver an interface to the
		589	C<AnyEvent> module - any module using it will work inside urxvt without
		590	further work. The only exception is that you cannot wait on condition
		591	variables, but non-blocking condvar use is ok. What this means is that you
		592	cannot use blocking APIs, but the non-blocking variant should work.
		593
		594	=cut
		595
		596	our $VERSION = 1;
		597
		598	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		599	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		600
		601	sub timer {
		602	my ($class, %arg) = @_;
		603
		604	my $cb = $arg{cb};
		605
		606	urxvt::timer
		607	->new
		608	->start (urxvt::NOW + $arg{after})
		609	->cb (sub {
		610	$_[0]->stop; # need to cancel manually
		611	$cb->();
		612	})
		613	}
		614
		615	sub io {
		616	my ($class, %arg) = @_;
		617
		618	my $cb = $arg{cb};
		619
		620	bless [$arg{fh}, urxvt::iow
		621	->new
		622	->fd (fileno $arg{fh})
		623	->events (($arg{poll} =~ /r/ ? 1 : 0)
		624	\| ($arg{poll} =~ /w/ ? 2 : 0))
		625	->start
		626	->cb (sub {
		627	$cb->(($_[1] & 1 ? 'r' : '')
		628	. ($_[1] & 2 ? 'w' : ''));
		629	})],
		630	urxvt::anyevent::
		631	}
		632
		633	sub DESTROY {
		634	$_[0][1]->stop;
		635	}
		636
		637	sub condvar {
		638	bless \my $flag, urxvt::anyevent::condvar::
		639	}
		640
		641	sub urxvt::anyevent::condvar::broadcast {
		642	${$_[0]}++;
		643	}
		644
		645	sub urxvt::anyevent::condvar::wait {
		646	unless (${$_[0]}) {
		647	require Carp;
		648	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		649	}
		650	}
		651
		652	package urxvt::term;
		653
423	=head2 The C<urxvt::term> Class	654	=head2 The C<urxvt::term> Class
424		655
425	=over 4	656	=over 4
		657
		658	=cut
		659
		660	# find on_xxx subs in the package and register them
		661	# as hooks
		662	sub register_package {
		663	my ($self, $pkg, $argv) = @_;
		664
		665	my $proxy = bless { argv => $argv }, $pkg;
		666	Scalar::Util::weaken ($proxy->{term} = $TERM);
		667
		668	$self->{_pkg}{$pkg} = $proxy;
		669
		670	for my $htype (0.. $#HOOKNAME) {
		671	my $name = $HOOKNAME[$htype];
		672
		673	my $ref = $pkg->can ("on_" . lc $name)
		674	or next;
		675
		676	$self->{_hook}[$htype]{$pkg} = $ref;
		677	$hook_count[$htype]++
		678	or urxvt::set_should_invoke $htype, 1;
		679	}
		680	}
		681
		682	=item $term->destroy
		683
		684	Destroy the terminal object (close the window, free resources etc.).
		685
		686	=item $isset = $term->option ($optval[, $set])
		687
		688	Returns true if the option specified by C<$optval> is enabled, and
		689	optionally change it. All option values are stored by name in the hash
		690	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		691
		692	Here is a a likely non-exhaustive list of option names, please see the
		693	source file F</src/optinc.h> to see the actual list:
		694
		695	borderLess console cursorBlink cursorUnderline hold iconic insecure
		696	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		697	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		698	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		699	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		700	tripleclickwords utmpInhibit visualBell
426		701
427	=item $value = $term->resource ($name[, $newval])	702	=item $value = $term->resource ($name[, $newval])
428		703
429	Returns the current resource value associated with a given name and	704	Returns the current resource value associated with a given name and
430	optionally sets a new value. Setting values is most useful in the C<init>	705	optionally sets a new value. Setting values is most useful in the C<init>
…		…
440		715
441	Please note that resource strings will currently only be freed when the	716	Please note that resource strings will currently only be freed when the
442	terminal is destroyed, so changing options frequently will eat memory.	717	terminal is destroyed, so changing options frequently will eat memory.
443		718
444	Here is a a likely non-exhaustive list of resource names, not all of which	719	Here is a a likely non-exhaustive list of resource names, not all of which
445	are supported in every build, please see the source to see the actual	720	are supported in every build, please see the source file F</src/rsinc.h>
446	list:	721	to see the actual list:
447		722
448	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	723	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
449	borderLess color cursorBlink cursorUnderline cutchars delete_key	724	borderLess color cursorBlink cursorUnderline cutchars delete_key
450	display_name embed ext_bwidth fade font geometry hold iconName	725	display_name embed ext_bwidth fade font geometry hold iconName
451	imFont imLocale inputMethod insecure int_bwidth intensityStyles	726	imFont imLocale inputMethod insecure int_bwidth intensityStyles
452	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	727	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
453	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	728	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
454	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	729	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
455	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	730	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
456	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	731	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
457	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	732	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
458	shade term_name title transparent transparent_all tripleclickwords	733	shade term_name title transparent transparent_all tripleclickwords
459	utmpInhibit visualBell	734	utmpInhibit visualBell
460		735
461	=cut	736	=cut
462		737
463	sub urxvt::term::resource($$;$) {	738	sub resource($$;$) {
464	my ($self, $name) = (shift, shift);	739	my ($self, $name) = (shift, shift);
465	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	740	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
466	goto &urxvt::term::_resource;	741	&urxvt::term::_resource
467	}	742	}
		743
		744	=item $rend = $term->rstyle ([$new_rstyle])
		745
		746	Return and optionally change the current rendition. Text that is output by
		747	the terminal application will use this style.
		748
		749	=item ($row, $col) = $term->screen_cur ([$row, $col])
		750
		751	Return the current coordinates of the text cursor position and optionally
		752	set it (which is usually bad as applications don't expect that).
468		753
469	=item ($row, $col) = $term->selection_mark ([$row, $col])	754	=item ($row, $col) = $term->selection_mark ([$row, $col])
470		755
471	=item ($row, $col) = $term->selection_beg ([$row, $col])	756	=item ($row, $col) = $term->selection_beg ([$row, $col])
472		757
…		…
487	#=item $term->overlay ($x, $y, $text)	772	#=item $term->overlay ($x, $y, $text)
488	#	773	#
489	#Create a simple multi-line overlay box. See the next method for details.	774	#Create a simple multi-line overlay box. See the next method for details.
490	#	775	#
491	#=cut	776	#=cut
492		777	#
493	sub urxvt::term::scr_overlay {	778	#sub urxvt::term::scr_overlay {
494	die;
495	my ($self, $x, $y, $text) = @_;	779	# my ($self, $x, $y, $text) = @_;
496		780	#
497	my @lines = split /\n/, $text;	781	# my @lines = split /\n/, $text;
498		782	#
499	my $w = 0;	783	# my $w = 0;
500	for (map $self->strwidth ($_), @lines) {	784	# for (map $self->strwidth ($_), @lines) {
501	$w = $_ if $w < $_;	785	# $w = $_ if $w < $_;
502	}	786	# }
503		787	#
504	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	788	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
505	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	789	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
506	}	790	#}
507		791
508	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	792	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
509		793
510	Create a new (empty) overlay at the given position with the given	794	Create a new (empty) overlay at the given position with the given
511	width/height. C<$rstyle> defines the initial rendition style	795	width/height. C<$rstyle> defines the initial rendition style
…		…
538		822
539	If hidden, display the overlay again.	823	If hidden, display the overlay again.
540		824
541	=back	825	=back
542		826
		827	=item $popup = $term->popup ($event)
		828
		829	Creates a new C<urxvt::popup> object that implements a popup menu. The
		830	C<$event> I<must> be the event causing the menu to pop up (a button event,
		831	currently).
		832
		833	=cut
		834
		835	sub popup {
		836	my ($self, $event) = @_;
		837
		838	$self->grab ($event->{time}, 1)
		839	or return;
		840
		841	my $popup = bless {
		842	term => $self,
		843	event => $event,
		844	}, urxvt::popup::;
		845
		846	Scalar::Util::weaken $popup->{term};
		847
		848	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		849	Scalar::Util::weaken $self->{_destroy}{$popup};
		850
		851	$popup
		852	}
		853
543	=item $cellwidth = $term->strwidth $string	854	=item $cellwidth = $term->strwidth ($string)
544		855
545	Returns the number of screen-cells this string would need. Correctly	856	Returns the number of screen-cells this string would need. Correctly
546	accounts for wide and combining characters.	857	accounts for wide and combining characters.
547		858
548	=item $octets = $term->locale_encode $string	859	=item $octets = $term->locale_encode ($string)
549		860
550	Convert the given text string into the corresponding locale encoding.	861	Convert the given text string into the corresponding locale encoding.
551		862
552	=item $string = $term->locale_decode $octets	863	=item $string = $term->locale_decode ($octets)
553		864
554	Convert the given locale-encoded octets into a perl string.	865	Convert the given locale-encoded octets into a perl string.
		866
		867	=item $term->scr_add_lines ($string)
		868
		869	Write the given text string to the screen, as if output by the application
		870	running inside the terminal. It may not contain command sequences (escape
		871	codes), but is free to use line feeds, carriage returns and tabs. The
		872	string is a normal text string, not in locale-dependent encoding.
		873
		874	Normally its not a good idea to use this function, as programs might be
		875	confused by changes in cursor position or scrolling. Its useful inside a
		876	C<on_add_lines> hook, though.
		877
		878	=item $term->cmd_parse ($octets)
		879
		880	Similar to C<scr_add_lines>, but the argument must be in the
		881	locale-specific encoding of the terminal and can contain command sequences
		882	(escape codes) that will be interpreted.
555		883
556	=item $term->tt_write ($octets)	884	=item $term->tt_write ($octets)
557		885
558	Write the octets given in C<$data> to the tty (i.e. as program input). To	886	Write the octets given in C<$data> to the tty (i.e. as program input). To
559	pass characters instead of octets, you should convert your strings first	887	pass characters instead of octets, you should convert your strings first
560	to the locale-specific encoding using C<< $term->locale_encode >>.	888	to the locale-specific encoding using C<< $term->locale_encode >>.
561		889
		890	=item $windowid = $term->parent
		891
		892	Return the window id of the toplevel window.
		893
		894	=item $windowid = $term->vt
		895
		896	Return the window id of the terminal window.
		897
		898	=item $window_width = $term->width
		899
		900	=item $window_height = $term->height
		901
		902	=item $font_width = $term->fwidth
		903
		904	=item $font_height = $term->fheight
		905
		906	=item $font_ascent = $term->fbase
		907
562	=item $nrow = $term->nrow	908	=item $terminal_rows = $term->nrow
563		909
564	=item $ncol = $term->ncol	910	=item $terminal_columns = $term->ncol
565		911
566	Return the number of rows/columns of the terminal window (i.e. as	912	=item $has_focus = $term->focus
567	specified by C<-geometry>, excluding any scrollback).
568		913
569	=item $nsaved = $term->nsaved	914	=item $is_mapped = $term->mapped
570		915
571	Returns the number of lines in the scrollback buffer.	916	=item $max_scrollback = $term->saveLines
		917
		918	=item $nrow_plus_saveLines = $term->total_rows
		919
		920	=item $lines_in_scrollback = $term->nsaved
		921
		922	Return various integers describing terminal characteristics.
		923
		924	=item $lc_ctype = $term->locale
		925
		926	Returns the LC_CTYPE category string used by this rxvt-unicode.
		927
		928	=item $x_display = $term->display_id
		929
		930	Return the DISPLAY used by rxvt-unicode.
		931
		932	=item $modifiermask = $term->ModLevel3Mask
		933
		934	=item $modifiermask = $term->ModMetaMask
		935
		936	=item $modifiermask = $term->ModNumLockMask
		937
		938	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		939	AltGr), the meta key (often Alt) and the num lock key, if applicable.
572		940
573	=item $view_start = $term->view_start ([$newvalue])	941	=item $view_start = $term->view_start ([$newvalue])
574		942
575	Returns the negative row number of the topmost line. Minimum value is	943	Returns the negative row number of the topmost line. Minimum value is
576	C<0>, which displays the normal terminal contents. Larger values scroll	944	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
639	about the logical line that row C<$row_number> is part of. It supports the	1007	about the logical line that row C<$row_number> is part of. It supports the
640	following methods:	1008	following methods:
641		1009
642	=over 4	1010	=over 4
643		1011
644	=item $text = $line->t	1012	=item $text = $line->t ([$new_text])
645		1013
646	Returns the full text of the line, similar to C<ROW_t>	1014	Returns or replaces the full text of the line, similar to C<ROW_t>
647		1015
648	=item $rend = $line->r	1016	=item $rend = $line->r ([$new_rend])
649		1017
650	Returns the full rendition array of the line, similar to C<ROW_r>	1018	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
651		1019
652	=item $length = $line->l	1020	=item $length = $line->l
653		1021
654	Returns the length of the line in cells, similar to C<ROW_l>.	1022	Returns the length of the line in cells, similar to C<ROW_l>.
655		1023
…		…
670		1038
671	=back	1039	=back
672		1040
673	=cut	1041	=cut
674		1042
675	sub urxvt::term::line {	1043	sub line {
676	my ($self, $row) = @_;	1044	my ($self, $row) = @_;
677		1045
678	my $maxrow = $self->nrow - 1;	1046	my $maxrow = $self->nrow - 1;
679		1047
680	my ($beg, $end) = ($row, $row);	1048	my ($beg, $end) = ($row, $row);
…		…
684		1052
685	bless {	1053	bless {
686	term => $self,	1054	term => $self,
687	beg => $beg,	1055	beg => $beg,
688	end => $end,	1056	end => $end,
		1057	ncol => $self->ncol,
689	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1058	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
690	}, urxvt::line::	1059	}, urxvt::line::
691	}	1060	}
692		1061
693	sub urxvt::line::t {	1062	sub urxvt::line::t {
694	my ($self) = @_;	1063	my ($self) = @_;
695		1064
		1065	if (@_ > 1)
		1066	{
		1067	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1068	for $self->{beg} .. $self->{end};
		1069	}
		1070
		1071	defined wantarray &&
696	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1072	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
697	0, $self->{len}	1073	0, $self->{len}
698	}	1074	}
699		1075
700	sub urxvt::line::r {	1076	sub urxvt::line::r {
701	my ($self) = @_;	1077	my ($self) = @_;
702		1078
		1079	if (@_ > 1)
		1080	{
		1081	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1082	for $self->{beg} .. $self->{end};
		1083	}
		1084
		1085	if (defined wantarray) {
703	my $rend = [	1086	my $rend = [
704	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1087	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
705	];	1088	];
706	$#$rend = $self->{len} - 1;	1089	$#$rend = $self->{len} - 1;
707	$rend	1090	return $rend;
		1091	}
		1092
		1093	()
708	}	1094	}
709		1095
710	sub urxvt::line::beg { $_[0]{beg} }	1096	sub urxvt::line::beg { $_[0]{beg} }
711	sub urxvt::line::end { $_[0]{end} }	1097	sub urxvt::line::end { $_[0]{end} }
712	sub urxvt::line::l { $_[0]{len} }	1098	sub urxvt::line::l { $_[0]{len} }
713		1099
714	sub urxvt::line::offset_of {	1100	sub urxvt::line::offset_of {
715	my ($self, $row, $col) = @_;	1101	my ($self, $row, $col) = @_;
716		1102
717	($row - $self->{beg}) * $self->{term}->ncol + $col	1103	($row - $self->{beg}) * $self->{ncol} + $col
718	}	1104	}
719		1105
720	sub urxvt::line::coord_of {	1106	sub urxvt::line::coord_of {
721	my ($self, $offset) = @_;	1107	my ($self, $offset) = @_;
722		1108
723	use integer;	1109	use integer;
724		1110
725	(	1111	(
726	$offset / $self->{term}->ncol + $self->{beg},	1112	$offset / $self->{ncol} + $self->{beg},
727	$offset % $self->{term}->ncol	1113	$offset % $self->{ncol}
728	)	1114	)
729	}	1115	}
730		1116
731	=item ($row, $col) = $line->coord_of ($offset)
732	=item $text = $term->special_encode $string	1117	=item $text = $term->special_encode $string
733		1118
734	Converts a perl string into the special encoding used by rxvt-unicode,	1119	Converts a perl string into the special encoding used by rxvt-unicode,
735	where one character corresponds to one screen cell. See	1120	where one character corresponds to one screen cell. See
736	C<< $term->ROW_t >> for details.	1121	C<< $term->ROW_t >> for details.
…		…
738	=item $string = $term->special_decode $text	1123	=item $string = $term->special_decode $text
739		1124
740	Converts rxvt-unicodes text reprsentation into a perl string. See	1125	Converts rxvt-unicodes text reprsentation into a perl string. See
741	C<< $term->ROW_t >> for details.	1126	C<< $term->ROW_t >> for details.
742		1127
		1128	=item $success = $term->grab_button ($button, $modifiermask)
		1129
		1130	Registers a synchronous button grab. See the XGrabButton manpage.
		1131
		1132	=item $success = $term->grab ($eventtime[, $sync])
		1133
		1134	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1135	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1136
		1137	=item $term->allow_events_async
		1138
		1139	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1140
		1141	=item $term->allow_events_sync
		1142
		1143	Calls XAllowEvents with SyncBoth for the most recent grab.
		1144
		1145	=item $term->allow_events_replay
		1146
		1147	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1148	recent grab.
		1149
		1150	=item $term->ungrab
		1151
		1152	Calls XUngrab for the most recent grab. Is called automatically on
		1153	evaluation errors, as it is better to lose the grab in the error case as
		1154	the session.
		1155
743	=back	1156	=back
		1157
		1158	=cut
		1159
		1160	package urxvt::popup;
		1161
		1162	=head2 The C<urxvt::popup> Class
		1163
		1164	=over 4
		1165
		1166	=cut
		1167
		1168	sub add_item {
		1169	my ($self, $item) = @_;
		1170
		1171	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1172	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1173	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1174
		1175	$item->{render} \|\|= sub { $_[0]{text} };
		1176
		1177	push @{ $self->{item} }, $item;
		1178	}
		1179
		1180	sub add_separator {
		1181	my ($self, $sep) = @_;
		1182
		1183	$sep \|\|= "=";
		1184
		1185	$self->add_item ({
		1186	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1187	text => "",
		1188	render => sub { $sep x $self->{term}->ncol },
		1189	activate => sub { },
		1190	});
		1191	}
		1192
		1193	sub add_title {
		1194	my ($self, $title) = @_;
		1195
		1196	$self->add_item ({
		1197	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1198	text => $title,
		1199	activate => sub { },
		1200	});
		1201	}
		1202
		1203	sub add_button {
		1204	my ($self, $text, $cb) = @_;
		1205
		1206	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1207	}
		1208
		1209	sub add_toggle {
		1210	my ($self, $text, $cb, $value) = @_;
		1211
		1212	my $item; $item = {
		1213	type => "button",
		1214	text => " $text",
		1215	value => $value,
		1216	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1217	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1218	};
		1219
		1220	$self->add_item ($item);
		1221	}
		1222
		1223	sub show {
		1224	my ($self) = @_;
		1225
		1226	local $urxvt::popup::self = $self;
		1227
		1228	local $ENV{LC_ALL} = $self->{term}->locale;
		1229
		1230	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1231	"--transient-for" => $self->{term}->parent,
		1232	"-display" => $self->{term}->display_id,
		1233	"-pe" => "urxvt-popup")
		1234	or die "unable to create popup window\n";
		1235	}
		1236
		1237	sub DESTROY {
		1238	my ($self) = @_;
		1239
		1240	delete $self->{term}{_destroy}{$self};
		1241	$self->{term}->ungrab;
		1242	}
744		1243
745	=head2 The C<urxvt::timer> Class	1244	=head2 The C<urxvt::timer> Class
746		1245
747	This class implements timer watchers/events. Time is represented as a	1246	This class implements timer watchers/events. Time is represented as a
748	fractional number of seconds since the epoch. Example:	1247	fractional number of seconds since the epoch. Example:
…		…
850	This variable controls the verbosity level of the perl extension. Higher	1349	This variable controls the verbosity level of the perl extension. Higher
851	numbers indicate more verbose output.	1350	numbers indicate more verbose output.
852		1351
853	=over 4	1352	=over 4
854		1353
855	=item =0 - only fatal messages	1354	=item == 0 - fatal messages
856		1355
857	=item =3 - script loading and management	1356	=item >= 3 - script loading and management
858		1357
859	=item =10 - all events received	1358	=item >=10 - all events received
860		1359
861	=back	1360	=back
862		1361
863	=head1 AUTHOR	1362	=head1 AUTHOR
864		1363

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC vs. Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC vs.
Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC