[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.66 by root, Mon Jan 9 19:28:39 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
…		…
229	that calls this function.	333	that calls this function.
230		334
231	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
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
		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
234	=item $time = urxvt::NOW	344	=item $time = urxvt::NOW
235		345
236	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.
237		355
238	=back	356	=back
239		357
240	=head2 RENDITION	358	=head2 RENDITION
241		359
…		…
291		409
292	=cut	410	=cut
293		411
294	package urxvt;	412	package urxvt;
295		413
		414	use utf8;
296	use strict;	415	use strict;
297	use Scalar::Util ();	416	use Scalar::Util ();
		417	use List::Util ();
298		418
		419	our $VERSION = 1;
299	our $TERM;	420	our $TERM;
300	our @HOOKNAME;	421	our @HOOKNAME;
		422	our %OPTION;
301	our $LIBDIR;	423	our $LIBDIR;
302		424
303	BEGIN {	425	BEGIN {
304	urxvt->bootstrap;	426	urxvt->bootstrap;
305		427
…		…
308	my $msg = join "", @_;	430	my $msg = join "", @_;
309	$msg .= "\n"	431	$msg .= "\n"
310	unless $msg =~ /\n$/;	432	unless $msg =~ /\n$/;
311	urxvt::warn ($msg);	433	urxvt::warn ($msg);
312	};	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";
313	}	440	}
314		441
315	my @hook_count;	442	my @hook_count;
316	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
317		444
…		…
335	$hook_count[$htype]++	462	$hook_count[$htype]++
336	or set_should_invoke $htype, 1;	463	or set_should_invoke $htype, 1;
337	}	464	}
338	}	465	}
339		466
340	my $script_pkg = "script0000";	467	my $extension_pkg = "extension0000";
341	my %script_pkg;	468	my %extension_pkg;
342		469
343	# load a single script into its own package, once only	470	# load a single script into its own package, once only
344	sub script_package($) {	471	sub extension_package($) {
345	my ($path) = @_;	472	my ($path) = @_;
346		473
347	$script_pkg{$path} \|\|= do {	474	$extension_pkg{$path} \|\|= do {
348	my $pkg = "urxvt::" . ($script_pkg++);	475	my $pkg = "urxvt::" . ($extension_pkg++);
349		476
350	verbose 3, "loading script '$path' into package '$pkg'";	477	verbose 3, "loading extension '$path' into package '$pkg'";
351		478
352	open my $fh, "<:raw", $path	479	open my $fh, "<:raw", $path
353	or die "$path: $!";	480	or die "$path: $!";
354		481
355	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"
356	. "#line 1 \"$path\"\n{\n"	484	. "#line 1 \"$path\"\n{\n"
357	. (do { local $/; <$fh> })	485	. (do { local $/; <$fh> })
358	. "\n};\n1";	486	. "\n};\n1";
359		487
360	eval $source or die "$path: $@";	488	eval $source or die "$path: $@";
361		489
362	$pkg	490	$pkg
363	}	491	}
364	}	492	}
		493
		494	our $retval; # return value for urxvt
365		495
366	# called by the rxvt core	496	# called by the rxvt core
367	sub invoke {	497	sub invoke {
368	local $TERM = shift;	498	local $TERM = shift;
369	my $htype = shift;	499	my $htype = shift;
370		500
371	if ($htype == 0) { # INIT	501	if ($htype == 0) { # INIT
372	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		503
		504	my %want_ext;
373		505
374	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) {
375	my @files = grep -f $_, map "$_/$ext", @dirs;	517	my @files = grep -f $_, map "$_/$ext", @dirs;
376		518
377	if (@files) {	519	if (@files) {
378	register_package script_package $files[0];	520	register_package extension_package $files[0];
379	} else {	521	} else {
380	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";
381	}	523	}
382	}	524	}
383		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
384	} elsif ($htype == 1) { # DESTROY	556	if ($htype == 1) { # DESTROY
		557	# remove hooks if unused
385	if (my $hook = $TERM->{_hook}) {	558	if (my $hook = $TERM->{_hook}) {
386	for my $htype (0..$#$hook) {	559	for my $htype (0..$#$hook) {
387	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
388	or set_should_invoke $htype, 0;	561	or set_should_invoke $htype, 0;
389	}	562	}
390	}	563	}
		564
		565	# clear package objects
		566	%$_ = () for values %{ $TERM->{_pkg} };
		567
		568	# clear package
		569	%$TERM = ();
391	}	570	}
392		571
393	my $cb = $TERM->{_hook}[$htype]	572	$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	}	573	}
		574
		575	# urxvt::term::proxy
415		576
416	sub urxvt::term::proxy::AUTOLOAD {	577	sub urxvt::term::proxy::AUTOLOAD {
417	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
418	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
419		580
…		…
426	} or die "FATAL: unable to compile method forwarder: $@";	587	} or die "FATAL: unable to compile method forwarder: $@";
427		588
428	goto &$urxvt::term::proxy::AUTOLOAD;	589	goto &$urxvt::term::proxy::AUTOLOAD;
429	}	590	}
430		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");
		671	}
		672	}
		673
		674	package urxvt::term;
		675
431	=head2 The C<urxvt::term> Class	676	=head2 The C<urxvt::term> Class
432		677
433	=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
434		699
435	=item $value = $term->resource ($name[, $newval])	700	=item $value = $term->resource ($name[, $newval])
436		701
437	Returns the current resource value associated with a given name and	702	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>	703	optionally sets a new value. Setting values is most useful in the C<init>
…		…
448		713
449	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
450	terminal is destroyed, so changing options frequently will eat memory.	715	terminal is destroyed, so changing options frequently will eat memory.
451		716
452	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
453	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>
454	list:	719	to see the actual list:
455		720
456	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	721	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
457	borderLess color cursorBlink cursorUnderline cutchars delete_key	722	borderLess color cursorBlink cursorUnderline cutchars delete_key
458	display_name embed ext_bwidth fade font geometry hold iconName	723	display_name embed ext_bwidth fade font geometry hold iconName
459	imFont imLocale inputMethod insecure int_bwidth intensityStyles	724	imFont imLocale inputMethod insecure int_bwidth intensityStyles
460	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	725	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
461	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	726	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
462	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	727	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
463	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	728	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
464	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	729	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
465	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	730	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
466	shade term_name title transparent transparent_all tripleclickwords	731	shade term_name title transparent transparent_all tripleclickwords
467	utmpInhibit visualBell	732	utmpInhibit visualBell
468		733
469	=cut	734	=cut
470		735
471	sub urxvt::term::resource($$;$) {	736	sub resource($$;$) {
472	my ($self, $name) = (shift, shift);	737	my ($self, $name) = (shift, shift);
473	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
474	goto &urxvt::term::_resource;	739	&urxvt::term::_resource
475	}	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).
476		751
477	=item ($row, $col) = $term->selection_mark ([$row, $col])	752	=item ($row, $col) = $term->selection_mark ([$row, $col])
478		753
479	=item ($row, $col) = $term->selection_beg ([$row, $col])	754	=item ($row, $col) = $term->selection_beg ([$row, $col])
480		755
…		…
495	#=item $term->overlay ($x, $y, $text)	770	#=item $term->overlay ($x, $y, $text)
496	#	771	#
497	#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.
498	#	773	#
499	#=cut	774	#=cut
500		775	#
501	sub urxvt::term::scr_overlay {	776	#sub urxvt::term::scr_overlay {
502	die;
503	my ($self, $x, $y, $text) = @_;	777	# my ($self, $x, $y, $text) = @_;
504		778	#
505	my @lines = split /\n/, $text;	779	# my @lines = split /\n/, $text;
506		780	#
507	my $w = 0;	781	# my $w = 0;
508	for (map $self->strwidth ($_), @lines) {	782	# for (map $self->strwidth ($_), @lines) {
509	$w = $_ if $w < $_;	783	# $w = $_ if $w < $_;
510	}	784	# }
511		785	#
512	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
513	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
514	}	788	#}
515		789
516	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
517		791
518	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
519	width/height. C<$rstyle> defines the initial rendition style	793	width/height. C<$rstyle> defines the initial rendition style
…		…
546		820
547	If hidden, display the overlay again.	821	If hidden, display the overlay again.
548		822
549	=back	823	=back
550		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
551	=item $cellwidth = $term->strwidth $string	852	=item $cellwidth = $term->strwidth ($string)
552		853
553	Returns the number of screen-cells this string would need. Correctly	854	Returns the number of screen-cells this string would need. Correctly
554	accounts for wide and combining characters.	855	accounts for wide and combining characters.
555		856
556	=item $octets = $term->locale_encode $string	857	=item $octets = $term->locale_encode ($string)
557		858
558	Convert the given text string into the corresponding locale encoding.	859	Convert the given text string into the corresponding locale encoding.
559		860
560	=item $string = $term->locale_decode $octets	861	=item $string = $term->locale_decode ($octets)
561		862
562	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.
563		881
564	=item $term->tt_write ($octets)	882	=item $term->tt_write ($octets)
565		883
566	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
567	pass characters instead of octets, you should convert your strings first	885	pass characters instead of octets, you should convert your strings first
568	to the locale-specific encoding using C<< $term->locale_encode >>.	886	to the locale-specific encoding using C<< $term->locale_encode >>.
569		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
570	=item $nrow = $term->nrow	906	=item $terminal_rows = $term->nrow
571		907
572	=item $ncol = $term->ncol	908	=item $terminal_columns = $term->ncol
573		909
574	Return the number of rows/columns of the terminal window (i.e. as	910	=item $has_focus = $term->focus
575	specified by C<-geometry>, excluding any scrollback).
576		911
577	=item $nsaved = $term->nsaved	912	=item $is_mapped = $term->mapped
578		913
579	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 $lc_ctype = $term->locale
		923
		924	Returns the LC_CTYPE category string used by this rxvt-unicode.
		925
		926	=item $x_display = $term->display_id
		927
		928	Return the DISPLAY used by rxvt-unicode.
		929
		930	=item $modifiermask = $term->ModLevel3Mask
		931
		932	=item $modifiermask = $term->ModMetaMask
		933
		934	=item $modifiermask = $term->ModNumLockMask
		935
		936	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		937	AltGr), the meta key (often Alt) and the num lock key, if applicable.
580		938
581	=item $view_start = $term->view_start ([$newvalue])	939	=item $view_start = $term->view_start ([$newvalue])
582		940
583	Returns the negative row number of the topmost line. Minimum value is	941	Returns the negative row number of the topmost line. Minimum value is
584	C<0>, which displays the normal terminal contents. Larger values scroll	942	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	1005	about the logical line that row C<$row_number> is part of. It supports the
648	following methods:	1006	following methods:
649		1007
650	=over 4	1008	=over 4
651		1009
652	=item $text = $line->t	1010	=item $text = $line->t ([$new_text])
653		1011
654	Returns the full text of the line, similar to C<ROW_t>	1012	Returns or replaces the full text of the line, similar to C<ROW_t>
655		1013
656	=item $rend = $line->r	1014	=item $rend = $line->r ([$new_rend])
657		1015
658	Returns the full rendition array of the line, similar to C<ROW_r>	1016	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
659		1017
660	=item $length = $line->l	1018	=item $length = $line->l
661		1019
662	Returns the length of the line in cells, similar to C<ROW_l>.	1020	Returns the length of the line in cells, similar to C<ROW_l>.
663		1021
…		…
678		1036
679	=back	1037	=back
680		1038
681	=cut	1039	=cut
682		1040
683	sub urxvt::term::line {	1041	sub line {
684	my ($self, $row) = @_;	1042	my ($self, $row) = @_;
685		1043
686	my $maxrow = $self->nrow - 1;	1044	my $maxrow = $self->nrow - 1;
687		1045
688	my ($beg, $end) = ($row, $row);	1046	my ($beg, $end) = ($row, $row);
…		…
692		1050
693	bless {	1051	bless {
694	term => $self,	1052	term => $self,
695	beg => $beg,	1053	beg => $beg,
696	end => $end,	1054	end => $end,
		1055	ncol => $self->ncol,
697	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1056	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
698	}, urxvt::line::	1057	}, urxvt::line::
699	}	1058	}
700		1059
701	sub urxvt::line::t {	1060	sub urxvt::line::t {
702	my ($self) = @_;	1061	my ($self) = @_;
703		1062
		1063	if (@_ > 1)
		1064	{
		1065	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1066	for $self->{beg} .. $self->{end};
		1067	}
		1068
		1069	defined wantarray &&
704	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1070	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
705	0, $self->{len}	1071	0, $self->{len}
706	}	1072	}
707		1073
708	sub urxvt::line::r {	1074	sub urxvt::line::r {
709	my ($self) = @_;	1075	my ($self) = @_;
710		1076
		1077	if (@_ > 1)
		1078	{
		1079	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1080	for $self->{beg} .. $self->{end};
		1081	}
		1082
		1083	if (defined wantarray) {
711	my $rend = [	1084	my $rend = [
712	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1085	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
713	];	1086	];
714	$#$rend = $self->{len} - 1;	1087	$#$rend = $self->{len} - 1;
715	$rend	1088	return $rend;
		1089	}
		1090
		1091	()
716	}	1092	}
717		1093
718	sub urxvt::line::beg { $_[0]{beg} }	1094	sub urxvt::line::beg { $_[0]{beg} }
719	sub urxvt::line::end { $_[0]{end} }	1095	sub urxvt::line::end { $_[0]{end} }
720	sub urxvt::line::l { $_[0]{len} }	1096	sub urxvt::line::l { $_[0]{len} }
721		1097
722	sub urxvt::line::offset_of {	1098	sub urxvt::line::offset_of {
723	my ($self, $row, $col) = @_;	1099	my ($self, $row, $col) = @_;
724		1100
725	($row - $self->{beg}) * $self->{term}->ncol + $col	1101	($row - $self->{beg}) * $self->{ncol} + $col
726	}	1102	}
727		1103
728	sub urxvt::line::coord_of {	1104	sub urxvt::line::coord_of {
729	my ($self, $offset) = @_;	1105	my ($self, $offset) = @_;
730		1106
731	use integer;	1107	use integer;
732		1108
733	(	1109	(
734	$offset / $self->{term}->ncol + $self->{beg},	1110	$offset / $self->{ncol} + $self->{beg},
735	$offset % $self->{term}->ncol	1111	$offset % $self->{ncol}
736	)	1112	)
737	}	1113	}
738		1114
739	=item ($row, $col) = $line->coord_of ($offset)
740	=item $text = $term->special_encode $string	1115	=item $text = $term->special_encode $string
741		1116
742	Converts a perl string into the special encoding used by rxvt-unicode,	1117	Converts a perl string into the special encoding used by rxvt-unicode,
743	where one character corresponds to one screen cell. See	1118	where one character corresponds to one screen cell. See
744	C<< $term->ROW_t >> for details.	1119	C<< $term->ROW_t >> for details.
…		…
746	=item $string = $term->special_decode $text	1121	=item $string = $term->special_decode $text
747		1122
748	Converts rxvt-unicodes text reprsentation into a perl string. See	1123	Converts rxvt-unicodes text reprsentation into a perl string. See
749	C<< $term->ROW_t >> for details.	1124	C<< $term->ROW_t >> for details.
750		1125
		1126	=item $success = $term->grab_button ($button, $modifiermask)
		1127
		1128	Registers a synchronous button grab. See the XGrabButton manpage.
		1129
		1130	=item $success = $term->grab ($eventtime[, $sync])
		1131
		1132	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1133	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1134
		1135	=item $term->allow_events_async
		1136
		1137	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1138
		1139	=item $term->allow_events_sync
		1140
		1141	Calls XAllowEvents with SyncBoth for the most recent grab.
		1142
		1143	=item $term->allow_events_replay
		1144
		1145	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1146	recent grab.
		1147
		1148	=item $term->ungrab
		1149
		1150	Calls XUngrab for the most recent grab. Is called automatically on
		1151	evaluation errors, as it is better to lose the grab in the error case as
		1152	the session.
		1153
751	=back	1154	=back
		1155
		1156	=cut
		1157
		1158	package urxvt::popup;
		1159
		1160	=head2 The C<urxvt::popup> Class
		1161
		1162	=over 4
		1163
		1164	=cut
		1165
		1166	sub add_item {
		1167	my ($self, $item) = @_;
		1168
		1169	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1170	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1171	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1172
		1173	$item->{render} \|\|= sub { $_[0]{text} };
		1174
		1175	push @{ $self->{item} }, $item;
		1176	}
		1177
		1178	sub add_separator {
		1179	my ($self, $sep) = @_;
		1180
		1181	$sep \|\|= "═";
		1182
		1183	$self->add_item ({
		1184	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1185	text => "",
		1186	render => sub { $sep x $self->{term}->ncol },
		1187	activate => sub { },
		1188	});
		1189	}
		1190
		1191	sub add_title {
		1192	my ($self, $title) = @_;
		1193
		1194	$self->add_item ({
		1195	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1196	text => $title,
		1197	activate => sub { },
		1198	});
		1199	}
		1200
		1201	sub add_button {
		1202	my ($self, $text, $cb) = @_;
		1203
		1204	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1205	}
		1206
		1207	sub add_toggle {
		1208	my ($self, $text, $cb, $value) = @_;
		1209
		1210	my $item; $item = {
		1211	type => "button",
		1212	text => " $text",
		1213	value => $value,
		1214	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1215	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1216	};
		1217
		1218	$self->add_item ($item);
		1219	}
		1220
		1221	sub show {
		1222	my ($self) = @_;
		1223
		1224	local $urxvt::popup::self = $self;
		1225
		1226	local $ENV{LC_ALL} = $self->{term}->locale;
		1227
		1228	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1229	"--transient-for" => $self->{term}->parent,
		1230	"-display" => $self->{term}->display_id,
		1231	"-pe" => "urxvt-popup")
		1232	or die "unable to create popup window\n";
		1233	}
		1234
		1235	sub DESTROY {
		1236	my ($self) = @_;
		1237
		1238	delete $self->{term}{_destroy}{$self};
		1239	$self->{term}->ungrab;
		1240	}
752		1241
753	=head2 The C<urxvt::timer> Class	1242	=head2 The C<urxvt::timer> Class
754		1243
755	This class implements timer watchers/events. Time is represented as a	1244	This class implements timer watchers/events. Time is represented as a
756	fractional number of seconds since the epoch. Example:	1245	fractional number of seconds since the epoch. Example:
…		…
858	This variable controls the verbosity level of the perl extension. Higher	1347	This variable controls the verbosity level of the perl extension. Higher
859	numbers indicate more verbose output.	1348	numbers indicate more verbose output.
860		1349
861	=over 4	1350	=over 4
862		1351
863	=item =0 - only fatal messages	1352	=item == 0 - fatal messages
864		1353
865	=item =3 - script loading and management	1354	=item >= 3 - script loading and management
866		1355
867	=item =10 - all events received	1356	=item >=10 - all events received
868		1357
869	=back	1358	=back
870		1359
871	=head1 AUTHOR	1360	=head1 AUTHOR
872		1361

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.66 by root, Mon Jan 9 19:28:39 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.66 by root, Mon Jan 9 19:28:39 2006 UTC