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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.20 by root, Tue Jan 3 04:18:47 2006 UTC vs.
Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.20 by root, Tue Jan 3 04:18:47 2006 UTC vs. Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.20 by root, Tue Jan 3 04:18:47 2006 UTC vs.
Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC