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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.28 by root, Wed Jan 4 00:09:12 2006 UTC vs. Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.28 by root, Wed Jan 4 00:09:12 2006 UTC vs.
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC