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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC vs.
Revision 1.55 by root, Sun Jan 8 05:50:27 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-Button3 that lets you toggle (some) options at
		64	runtime.
		65
61	=item digital-clock	66	=item digital-clock
62		67
63	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.
64		79
65	=item example-refresh-hooks	80	=item example-refresh-hooks
66		81
67	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
68	window. Illustrates overwriting the refresh callbacks to create your own	83	window. Illustrates overwriting the refresh callbacks to create your own
…		…
81	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
82	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
83	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
84	terminal is destroyed.	99	terminal is destroyed.
85		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
86	=head2 Hooks	124	=head2 Hooks
87		125
88	The following subroutines can be declared in loaded scripts, and will be	126	The following subroutines can be declared in extension files, and will be
89	called whenever the relevant event happens.	127	called whenever the relevant event happens.
90		128
91	The first argument passed to them is an object private to each terminal	129	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	130	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>	131	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>	132	object that is shared between all packages is stored in the C<term>
95	member.	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.
96		135
97	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
98	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,
99	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.
100		139
…		…
103	=over 4	142	=over 4
104		143
105	=item on_init $term	144	=item on_init $term
106		145
107	Called after a new terminal object has been initialized, but before	146	Called after a new terminal object has been initialized, but before
108	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.
109		151
110	=item on_reset $term	152	=item on_reset $term
111		153
112	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
113	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
…		…
142	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
143	processing.	185	processing.
144		186
145	See the F<selection> example extension.	187	See the F<selection> example extension.
146		188
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	189	=item on_view_change $term, $offset
158		190
159	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
160	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
161	show this many lines of scrollback.	193	show this many lines of scrollback.
…		…
171	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
172		204
173	=item on_tty_activity $term NYI	205	=item on_tty_activity $term NYI
174		206
175	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.
176		243
177	=item on_refresh_begin $term	244	=item on_refresh_begin $term
178		245
179	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
180	or similar effects by modify terminal contents in refresh_begin, and	247	or similar effects by modify terminal contents in refresh_begin, and
…		…
189		256
190	Called whenever the user presses a key combination that has a	257	Called whenever the user presses a key combination that has a
191	C<perl:string> action bound to it (see description of the B<keysym>	258	C<perl:string> action bound to it (see description of the B<keysym>
192	resource in the @@RXVT_NAME@@(1) manpage).	259	resource in the @@RXVT_NAME@@(1) manpage).
193		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
194	=back	297	=back
195		298
196	=head2 Variables in the C<urxvt> Package	299	=head2 Variables in the C<urxvt> Package
197		300
198	=over 4	301	=over 4
199		302
200	=item $urxvt::TERM	303	=item $urxvt::TERM
201		304
202	The current terminal. Whenever a callback/Hook is bein executed, this	305	The current terminal. This variable stores the current C<urxvt::term>
203	variable stores the current C<urxvt::term> object.	306	object, whenever a callback/hook is executing.
204		307
205	=back	308	=back
206		309
207	=head2 Functions in the C<urxvt> Package	310	=head2 Functions in the C<urxvt> Package
208		311
209	=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.
210		321
211	=item urxvt::fatal $errormessage	322	=item urxvt::fatal $errormessage
212		323
213	Fatally aborts execution with the given error message. Avoid at all	324	Fatally aborts execution with the given error message. Avoid at all
214	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
…		…
224	correct place, e.g. on stderr of the connecting urxvtc client.	335	correct place, e.g. on stderr of the connecting urxvtc client.
225		336
226	=item $time = urxvt::NOW	337	=item $time = urxvt::NOW
227		338
228	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.
229		348
230	=back	349	=back
231		350
232	=head2 RENDITION	351	=head2 RENDITION
233		352
…		…
283		402
284	=cut	403	=cut
285		404
286	package urxvt;	405	package urxvt;
287		406
		407	use utf8;
288	use strict;	408	use strict;
289	use Scalar::Util ();	409	use Scalar::Util ();
		410	use List::Util ();
290		411
		412	our $VERSION = 1;
291	our $TERM;	413	our $TERM;
292	our @HOOKNAME;	414	our @HOOKNAME;
		415	our %OPTION;
293	our $LIBDIR;	416	our $LIBDIR;
294		417
295	BEGIN {	418	BEGIN {
296	urxvt->bootstrap;	419	urxvt->bootstrap;
297		420
…		…
327	$hook_count[$htype]++	450	$hook_count[$htype]++
328	or set_should_invoke $htype, 1;	451	or set_should_invoke $htype, 1;
329	}	452	}
330	}	453	}
331		454
332	my $script_pkg = "script0000";	455	my $extension_pkg = "extension0000";
333	my %script_pkg;	456	my %extension_pkg;
334		457
335	# load a single script into its own package, once only	458	# load a single script into its own package, once only
336	sub script_package($) {	459	sub extension_package($) {
337	my ($path) = @_;	460	my ($path) = @_;
338		461
339	$script_pkg{$path} \|\|= do {	462	$extension_pkg{$path} \|\|= do {
340	my $pkg = "urxvt::" . ($script_pkg++);	463	my $pkg = "urxvt::" . ($extension_pkg++);
341		464
342	verbose 3, "loading script '$path' into package '$pkg'";	465	verbose 3, "loading extension '$path' into package '$pkg'";
343		466
344	open my $fh, "<:raw", $path	467	open my $fh, "<:raw", $path
345	or die "$path: $!";	468	or die "$path: $!";
346		469
347	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"
348	. "#line 1 \"$path\"\n{\n"	472	. "#line 1 \"$path\"\n{\n"
349	. (do { local $/; <$fh> })	473	. (do { local $/; <$fh> })
350	. "\n};\n1";	474	. "\n};\n1";
351		475
352	eval $source or die "$path: $@";	476	eval $source or die "$path: $@";
353		477
354	$pkg	478	$pkg
355	}	479	}
356	}	480	}
		481
		482	our $retval; # return value for urxvt
357		483
358	# called by the rxvt core	484	# called by the rxvt core
359	sub invoke {	485	sub invoke {
360	local $TERM = shift;	486	local $TERM = shift;
361	my $htype = shift;	487	my $htype = shift;
362		488
363	if ($htype == 0) { # INIT	489	if ($htype == 0) { # INIT
364	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	490	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		491
		492	my %want_ext;
365		493
366	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) {
367	my @files = grep -f $_, map "$_/$ext", @dirs;	505	my @files = grep -f $_, map "$_/$ext", @dirs;
368		506
369	if (@files) {	507	if (@files) {
370	register_package script_package $files[0];	508	register_package extension_package $files[0];
371	} else {	509	} else {
372	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";
373	}	511	}
374	}	512	}
375		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
376	} elsif ($htype == 1) { # DESTROY	541	if ($htype == 1) { # DESTROY
		542	# remove hooks if unused
377	if (my $hook = $TERM->{_hook}) {	543	if (my $hook = $TERM->{_hook}) {
378	for my $htype (0..$#$hook) {	544	for my $htype (0..$#$hook) {
379	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	545	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
380	or set_should_invoke $htype, 0;	546	or set_should_invoke $htype, 0;
381	}	547	}
382	}	548	}
		549
		550	# clear package objects
		551	%$_ = () for values %{ $TERM->{_pkg} };
		552
		553	# clear package
		554	%$TERM = ();
383	}	555	}
384		556
385	my $cb = $TERM->{_hook}[$htype]	557	$retval
386	or return;
387
388	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
389	if $verbosity >= 10;
390
391	keys %$cb;
392
393	while (my ($pkg, $cb) = each %$cb) {
394	return 1
395	if $cb->(
396	$TERM->{$pkg} \|\|= do {
397	my $proxy = bless { }, urxvt::term::proxy::;
398	Scalar::Util::weaken ($proxy->{term} = $TERM);
399	$proxy
400	},
401	@_,
402	);
403	}
404
405	0
406	}	558	}
		559
		560	# urxvt::term::proxy
407		561
408	sub urxvt::term::proxy::AUTOLOAD {	562	sub urxvt::term::proxy::AUTOLOAD {
409	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	563	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
410	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	564	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
411		565
…		…
418	} or die "FATAL: unable to compile method forwarder: $@";	572	} or die "FATAL: unable to compile method forwarder: $@";
419		573
420	goto &$urxvt::term::proxy::AUTOLOAD;	574	goto &$urxvt::term::proxy::AUTOLOAD;
421	}	575	}
422		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	# urxvt::anyevent
		588
		589	package urxvt::anyevent;
		590
		591	our $VERSION = 1;
		592
		593	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		594	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		595
		596	sub timer {
		597	my ($class, %arg) = @_;
		598
		599	my $cb = $arg{cb};
		600
		601	urxvt::timer
		602	->new
		603	->start (urxvt::NOW + $arg{after})
		604	->cb (sub {
		605	$_[0]->stop; # need to cancel manually
		606	$cb->();
		607	})
		608	}
		609
		610	sub io {
		611	my ($class, %arg) = @_;
		612
		613	my $cb = $arg{cb};
		614
		615	bless [$arg{fh}, urxvt::iow
		616	->new
		617	->fd (fileno $arg{fh})
		618	->events (($arg{poll} =~ /r/ ? 1 : 0)
		619	\| ($arg{poll} =~ /w/ ? 2 : 0))
		620	->start
		621	->cb (sub {
		622	$cb->(($_[1] & 1 ? 'r' : '')
		623	. ($_[1] & 2 ? 'w' : ''));
		624	})],
		625	urxvt::anyevent::
		626	}
		627
		628	sub DESTROY {
		629	$_[0][1]->stop;
		630	}
		631
		632	sub condvar {
		633	bless \my $flag, urxvt::anyevent::condvar::
		634	}
		635
		636	sub urxvt::anyevent::condvar::broadcast {
		637	${$_[0]}++;
		638	}
		639
		640	sub urxvt::anyevent::condvar::wait {
		641	unless (${$_[0]}) {
		642	require Carp;
		643	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		644	}
		645	}
		646
		647	package urxvt::term;
		648
423	=head2 The C<urxvt::term> Class	649	=head2 The C<urxvt::term> Class
424		650
425	=over 4	651	=over 4
		652
		653	=item $term->destroy
		654
		655	Destroy the terminal object (close the window, free resources etc.).
		656
		657	=item $isset = $term->option ($optval[, $set])
		658
		659	Returns true if the option specified by C<$optval> is enabled, and
		660	optionally change it. All option values are stored by name in the hash
		661	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		662
		663	Here is a a likely non-exhaustive list of option names, please see the
		664	source file F</src/optinc.h> to see the actual list:
		665
		666	borderLess console cursorBlink cursorUnderline hold iconic insecure
		667	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		668	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		669	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		670	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		671	tripleclickwords utmpInhibit visualBell
426		672
427	=item $value = $term->resource ($name[, $newval])	673	=item $value = $term->resource ($name[, $newval])
428		674
429	Returns the current resource value associated with a given name and	675	Returns the current resource value associated with a given name and
430	optionally sets a new value. Setting values is most useful in the C<init>	676	optionally sets a new value. Setting values is most useful in the C<init>
…		…
440		686
441	Please note that resource strings will currently only be freed when the	687	Please note that resource strings will currently only be freed when the
442	terminal is destroyed, so changing options frequently will eat memory.	688	terminal is destroyed, so changing options frequently will eat memory.
443		689
444	Here is a a likely non-exhaustive list of resource names, not all of which	690	Here is a a likely non-exhaustive list of resource names, not all of which
445	are supported in every build, please see the source to see the actual	691	are supported in every build, please see the source file F</src/rsinc.h>
446	list:	692	to see the actual list:
447		693
448	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	694	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
449	borderLess color cursorBlink cursorUnderline cutchars delete_key	695	borderLess color cursorBlink cursorUnderline cutchars delete_key
450	display_name embed ext_bwidth fade font geometry hold iconName	696	display_name embed ext_bwidth fade font geometry hold iconName
451	imFont imLocale inputMethod insecure int_bwidth intensityStyles	697	imFont imLocale inputMethod insecure int_bwidth intensityStyles
452	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	698	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
453	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	699	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
454	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	700	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
455	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	701	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
456	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	702	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
457	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	703	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
458	shade term_name title transparent transparent_all tripleclickwords	704	shade term_name title transparent transparent_all tripleclickwords
459	utmpInhibit visualBell	705	utmpInhibit visualBell
460		706
461	=cut	707	=cut
462		708
463	sub urxvt::term::resource($$;$) {	709	sub resource($$;$) {
464	my ($self, $name) = (shift, shift);	710	my ($self, $name) = (shift, shift);
465	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	711	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
466	goto &urxvt::term::_resource;	712	&urxvt::term::_resource
467	}	713	}
		714
		715	=item $rend = $term->rstyle ([$new_rstyle])
		716
		717	Return and optionally change the current rendition. Text that is output by
		718	the terminal application will use this style.
		719
		720	=item ($row, $col) = $term->screen_cur ([$row, $col])
		721
		722	Return the current coordinates of the text cursor position and optionally
		723	set it (which is usually bad as applications don't expect that).
468		724
469	=item ($row, $col) = $term->selection_mark ([$row, $col])	725	=item ($row, $col) = $term->selection_mark ([$row, $col])
470		726
471	=item ($row, $col) = $term->selection_beg ([$row, $col])	727	=item ($row, $col) = $term->selection_beg ([$row, $col])
472		728
…		…
487	#=item $term->overlay ($x, $y, $text)	743	#=item $term->overlay ($x, $y, $text)
488	#	744	#
489	#Create a simple multi-line overlay box. See the next method for details.	745	#Create a simple multi-line overlay box. See the next method for details.
490	#	746	#
491	#=cut	747	#=cut
492		748	#
493	sub urxvt::term::scr_overlay {	749	#sub urxvt::term::scr_overlay {
494	die;
495	my ($self, $x, $y, $text) = @_;	750	# my ($self, $x, $y, $text) = @_;
496		751	#
497	my @lines = split /\n/, $text;	752	# my @lines = split /\n/, $text;
498		753	#
499	my $w = 0;	754	# my $w = 0;
500	for (map $self->strwidth ($_), @lines) {	755	# for (map $self->strwidth ($_), @lines) {
501	$w = $_ if $w < $_;	756	# $w = $_ if $w < $_;
502	}	757	# }
503		758	#
504	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	759	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
505	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	760	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
506	}	761	#}
507		762
508	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	763	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
509		764
510	Create a new (empty) overlay at the given position with the given	765	Create a new (empty) overlay at the given position with the given
511	width/height. C<$rstyle> defines the initial rendition style	766	width/height. C<$rstyle> defines the initial rendition style
…		…
538		793
539	If hidden, display the overlay again.	794	If hidden, display the overlay again.
540		795
541	=back	796	=back
542		797
		798	=item $popup = $term->popup ($event)
		799
		800	Creates a new C<urxvt::popup> object that implements a popup menu. The
		801	C<$event> I<must> be the event causing the menu to pop up (a button event,
		802	currently).
		803
		804	=cut
		805
		806	sub popup {
		807	my ($self, $event) = @_;
		808
		809	$self->grab ($event->{time}, 1)
		810	or return;
		811
		812	my $popup = bless {
		813	term => $self,
		814	event => $event,
		815	}, urxvt::popup::;
		816
		817	Scalar::Util::weaken $popup->{term};
		818
		819	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		820	Scalar::Util::weaken $self->{_destroy}{$popup};
		821
		822	$popup
		823	}
		824
543	=item $cellwidth = $term->strwidth $string	825	=item $cellwidth = $term->strwidth ($string)
544		826
545	Returns the number of screen-cells this string would need. Correctly	827	Returns the number of screen-cells this string would need. Correctly
546	accounts for wide and combining characters.	828	accounts for wide and combining characters.
547		829
548	=item $octets = $term->locale_encode $string	830	=item $octets = $term->locale_encode ($string)
549		831
550	Convert the given text string into the corresponding locale encoding.	832	Convert the given text string into the corresponding locale encoding.
551		833
552	=item $string = $term->locale_decode $octets	834	=item $string = $term->locale_decode ($octets)
553		835
554	Convert the given locale-encoded octets into a perl string.	836	Convert the given locale-encoded octets into a perl string.
		837
		838	=item $term->scr_add_lines ($string)
		839
		840	Write the given text string to the screen, as if output by the application
		841	running inside the terminal. It may not contain command sequences (escape
		842	codes), but is free to use line feeds, carriage returns and tabs. The
		843	string is a normal text string, not in locale-dependent encoding.
		844
		845	Normally its not a good idea to use this function, as programs might be
		846	confused by changes in cursor position or scrolling. Its useful inside a
		847	C<on_add_lines> hook, though.
		848
		849	=item $term->cmd_parse ($octets)
		850
		851	Similar to C<scr_add_lines>, but the argument must be in the
		852	locale-specific encoding of the terminal and can contain command sequences
		853	(escape codes) that will be interpreted.
555		854
556	=item $term->tt_write ($octets)	855	=item $term->tt_write ($octets)
557		856
558	Write the octets given in C<$data> to the tty (i.e. as program input). To	857	Write the octets given in C<$data> to the tty (i.e. as program input). To
559	pass characters instead of octets, you should convert your strings first	858	pass characters instead of octets, you should convert your strings first
560	to the locale-specific encoding using C<< $term->locale_encode >>.	859	to the locale-specific encoding using C<< $term->locale_encode >>.
561		860
		861	=item $windowid = $term->parent
		862
		863	Return the window id of the toplevel window.
		864
		865	=item $windowid = $term->vt
		866
		867	Return the window id of the terminal window.
		868
		869	=item $window_width = $term->width
		870
		871	=item $window_height = $term->height
		872
		873	=item $font_width = $term->fwidth
		874
		875	=item $font_height = $term->fheight
		876
		877	=item $font_ascent = $term->fbase
		878
562	=item $nrow = $term->nrow	879	=item $terminal_rows = $term->nrow
563		880
564	=item $ncol = $term->ncol	881	=item $terminal_columns = $term->ncol
565		882
566	Return the number of rows/columns of the terminal window (i.e. as	883	=item $has_focus = $term->focus
567	specified by C<-geometry>, excluding any scrollback).
568		884
569	=item $nsaved = $term->nsaved	885	=item $is_mapped = $term->mapped
570		886
571	Returns the number of lines in the scrollback buffer.	887	=item $max_scrollback = $term->saveLines
		888
		889	=item $nrow_plus_saveLines = $term->total_rows
		890
		891	=item $lines_in_scrollback = $term->nsaved
		892
		893	Return various integers describing terminal characteristics.
		894
		895	=item $modifiermask = $term->ModLevel3Mask
		896
		897	=item $modifiermask = $term->ModMetaMask
		898
		899	=item $modifiermask = $term->ModNumLockMask
		900
		901	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		902	AltGr), the meta key (often Alt) and the num lock key, if applicable.
572		903
573	=item $view_start = $term->view_start ([$newvalue])	904	=item $view_start = $term->view_start ([$newvalue])
574		905
575	Returns the negative row number of the topmost line. Minimum value is	906	Returns the negative row number of the topmost line. Minimum value is
576	C<0>, which displays the normal terminal contents. Larger values scroll	907	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
639	about the logical line that row C<$row_number> is part of. It supports the	970	about the logical line that row C<$row_number> is part of. It supports the
640	following methods:	971	following methods:
641		972
642	=over 4	973	=over 4
643		974
644	=item $text = $line->t	975	=item $text = $line->t ([$new_text])
645		976
646	Returns the full text of the line, similar to C<ROW_t>	977	Returns or replaces the full text of the line, similar to C<ROW_t>
647		978
648	=item $rend = $line->r	979	=item $rend = $line->r ([$new_rend])
649		980
650	Returns the full rendition array of the line, similar to C<ROW_r>	981	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
651		982
652	=item $length = $line->l	983	=item $length = $line->l
653		984
654	Returns the length of the line in cells, similar to C<ROW_l>.	985	Returns the length of the line in cells, similar to C<ROW_l>.
655		986
…		…
670		1001
671	=back	1002	=back
672		1003
673	=cut	1004	=cut
674		1005
675	sub urxvt::term::line {	1006	sub line {
676	my ($self, $row) = @_;	1007	my ($self, $row) = @_;
677		1008
678	my $maxrow = $self->nrow - 1;	1009	my $maxrow = $self->nrow - 1;
679		1010
680	my ($beg, $end) = ($row, $row);	1011	my ($beg, $end) = ($row, $row);
…		…
684		1015
685	bless {	1016	bless {
686	term => $self,	1017	term => $self,
687	beg => $beg,	1018	beg => $beg,
688	end => $end,	1019	end => $end,
		1020	ncol => $self->ncol,
689	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1021	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
690	}, urxvt::line::	1022	}, urxvt::line::
691	}	1023	}
692		1024
693	sub urxvt::line::t {	1025	sub urxvt::line::t {
694	my ($self) = @_;	1026	my ($self) = @_;
695		1027
		1028	if (@_ > 1)
		1029	{
		1030	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1031	for $self->{beg} .. $self->{end};
		1032	}
		1033
		1034	defined wantarray &&
696	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1035	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
697	0, $self->{len}	1036	0, $self->{len}
698	}	1037	}
699		1038
700	sub urxvt::line::r {	1039	sub urxvt::line::r {
701	my ($self) = @_;	1040	my ($self) = @_;
702		1041
		1042	if (@_ > 1)
		1043	{
		1044	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1045	for $self->{beg} .. $self->{end};
		1046	}
		1047
		1048	if (defined wantarray) {
703	my $rend = [	1049	my $rend = [
704	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1050	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
705	];	1051	];
706	$#$rend = $self->{len} - 1;	1052	$#$rend = $self->{len} - 1;
707	$rend	1053	return $rend;
		1054	}
		1055
		1056	()
708	}	1057	}
709		1058
710	sub urxvt::line::beg { $_[0]{beg} }	1059	sub urxvt::line::beg { $_[0]{beg} }
711	sub urxvt::line::end { $_[0]{end} }	1060	sub urxvt::line::end { $_[0]{end} }
712	sub urxvt::line::l { $_[0]{len} }	1061	sub urxvt::line::l { $_[0]{len} }
713		1062
714	sub urxvt::line::offset_of {	1063	sub urxvt::line::offset_of {
715	my ($self, $row, $col) = @_;	1064	my ($self, $row, $col) = @_;
716		1065
717	($row - $self->{beg}) * $self->{term}->ncol + $col	1066	($row - $self->{beg}) * $self->{ncol} + $col
718	}	1067	}
719		1068
720	sub urxvt::line::coord_of {	1069	sub urxvt::line::coord_of {
721	my ($self, $offset) = @_;	1070	my ($self, $offset) = @_;
722		1071
723	use integer;	1072	use integer;
724		1073
725	(	1074	(
726	$offset / $self->{term}->ncol + $self->{beg},	1075	$offset / $self->{ncol} + $self->{beg},
727	$offset % $self->{term}->ncol	1076	$offset % $self->{ncol}
728	)	1077	)
729	}	1078	}
730		1079
731	=item ($row, $col) = $line->coord_of ($offset)	1080	=item ($row, $col) = $line->coord_of ($offset)
732	=item $text = $term->special_encode $string	1081	=item $text = $term->special_encode $string
…		…
739		1088
740	Converts rxvt-unicodes text reprsentation into a perl string. See	1089	Converts rxvt-unicodes text reprsentation into a perl string. See
741	C<< $term->ROW_t >> for details.	1090	C<< $term->ROW_t >> for details.
742		1091
743	=back	1092	=back
		1093
		1094	=cut
		1095
		1096	package urxvt::popup;
		1097
		1098	=head2 The C<urxvt::popup> Class
		1099
		1100	=over 4
		1101
		1102	=cut
		1103
		1104	sub add_item {
		1105	my ($self, $item) = @_;
		1106
		1107	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1108	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1109	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1110
		1111	$item->{render} \|\|= sub { $_[0]{text} };
		1112
		1113	push @{ $self->{item} }, $item;
		1114	}
		1115
		1116	sub add_separator {
		1117	my ($self, $sep) = @_;
		1118
		1119	$sep \|\|= "═";
		1120
		1121	$self->add_item ({
		1122	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1123	text => "",
		1124	render => sub { $sep x $urxvt::TERM->ncol },
		1125	activate => sub { },
		1126	});
		1127	}
		1128
		1129	sub add_title {
		1130	my ($self, $title) = @_;
		1131
		1132	$self->add_item ({
		1133	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1134	text => $title,
		1135	activate => sub { },
		1136	});
		1137	}
		1138
		1139	sub add_button {
		1140	my ($self, $text, $cb) = @_;
		1141
		1142	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1143	}
		1144
		1145	sub add_toggle {
		1146	my ($self, $text, $cb, $value) = @_;
		1147
		1148	my $item; $item = {
		1149	type => "button",
		1150	text => " $text",
		1151	value => $value,
		1152	render => sub { ($item->{value} ? "* " : " ") . $text },
		1153	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1154	};
		1155
		1156	$self->add_item ($item);
		1157	}
		1158
		1159	sub show {
		1160	my ($self) = @_;
		1161
		1162	local $urxvt::popup::self = $self;
		1163
		1164	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1165	"--transient-for" => $self->{term}->parent,
		1166	"-pe" => "urxvt-popup")
		1167	or die "unable to create popup window\n";
		1168	}
		1169
		1170	sub DESTROY {
		1171	my ($self) = @_;
		1172
		1173	$self->{term}->ungrab;
		1174	}
744		1175
745	=head2 The C<urxvt::timer> Class	1176	=head2 The C<urxvt::timer> Class
746		1177
747	This class implements timer watchers/events. Time is represented as a	1178	This class implements timer watchers/events. Time is represented as a
748	fractional number of seconds since the epoch. Example:	1179	fractional number of seconds since the epoch. Example:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC vs. Revision 1.55 by root, Sun Jan 8 05:50:27 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC vs.
Revision 1.55 by root, Sun Jan 8 05:50:27 2006 UTC