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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC vs. Revision 1.56 by root, Sun Jan 8 05:52:42 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC vs.
Revision 1.56 by root, Sun Jan 8 05:52:42 2006 UTC