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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.54 by root, Sun Jan 8 01:59:29 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-Button3 that lets you toggle (some) options at
		64	runtime.
		65
56	=item digital-clock	66	=item digital-clock
57		67
58	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.
59		79
60	=item example-refresh-hooks	80	=item example-refresh-hooks
61		81
62	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
63	window. Illustrates overwriting the refresh callbacks to create your own	83	window. Illustrates overwriting the refresh callbacks to create your own
…		…
68	=head2 General API Considerations	88	=head2 General API Considerations
69		89
70	All objects (such as terminals, time watchers etc.) are typical	90	All objects (such as terminals, time watchers etc.) are typical
71	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
72	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
73	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
74	modified).	94	modified).
75		95
76	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
77	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
78	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
79	terminal is destroyed.	99	terminal is destroyed.
80		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
81	=head2 Hooks	124	=head2 Hooks
82		125
83	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
84	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.
85		135
86	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
87	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,
88	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.
89		139
…		…
92	=over 4	142	=over 4
93		143
94	=item on_init $term	144	=item on_init $term
95		145
96	Called after a new terminal object has been initialized, but before	146	Called after a new terminal object has been initialized, but before
97	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.
98		151
99	=item on_reset $term	152	=item on_reset $term
100		153
101	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
102	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
…		…
122	requested from the server. The selection text can be queried and changed	175	requested from the server. The selection text can be queried and changed
123	by calling C<< $term->selection >>.	176	by calling C<< $term->selection >>.
124		177
125	Returning a true value aborts selection grabbing. It will still be hilighted.	178	Returning a true value aborts selection grabbing. It will still be hilighted.
126		179
127	=item on_focus_in $term	180	=item on_sel_extend $term
128		181
129	Called whenever the window gets the keyboard focus, before urxvt does	182	Called whenever the user tries to extend the selection (e.g. with a double
130	focus in processing.	183	click) and is either supposed to return false (normal operation), or
131		184	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.	185	processing.
		186
		187	See the F<selection> example extension.
136		188
137	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
138		190
139	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
140	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
151	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
152		204
153	=item on_tty_activity $term NYI	205	=item on_tty_activity $term NYI
154		206
155	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.
156		243
157	=item on_refresh_begin $term	244	=item on_refresh_begin $term
158		245
159	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
160	or similar effects by modify terminal contents in refresh_begin, and	247	or similar effects by modify terminal contents in refresh_begin, and
…		…
169		256
170	Called whenever the user presses a key combination that has a	257	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>	258	C<perl:string> action bound to it (see description of the B<keysym>
172	resource in the @@RXVT_NAME@@(1) manpage).	259	resource in the @@RXVT_NAME@@(1) manpage).
173		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
174	=back	297	=back
175		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
176	=head2 Functions in the C<urxvt> Package	310	=head2 Functions in the C<urxvt> Package
177		311
178	=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.
179		321
180	=item urxvt::fatal $errormessage	322	=item urxvt::fatal $errormessage
181		323
182	Fatally aborts execution with the given error message. Avoid at all	324	Fatally aborts execution with the given error message. Avoid at all
183	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
…		…
193	correct place, e.g. on stderr of the connecting urxvtc client.	335	correct place, e.g. on stderr of the connecting urxvtc client.
194		336
195	=item $time = urxvt::NOW	337	=item $time = urxvt::NOW
196		338
197	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 events.
198		348
199	=back	349	=back
200		350
201	=head2 RENDITION	351	=head2 RENDITION
202		352
…		…
252		402
253	=cut	403	=cut
254		404
255	package urxvt;	405	package urxvt;
256		406
		407	use utf8;
257	use strict;	408	use strict;
		409	use Scalar::Util ();
		410	use List::Util ();
258		411
259	our $term;	412	our $TERM;
260	our @HOOKNAME;	413	our @HOOKNAME;
		414	our %OPTION;
261	our $LIBDIR;	415	our $LIBDIR;
262		416
263	BEGIN {	417	BEGIN {
264	urxvt->bootstrap;	418	urxvt->bootstrap;
265		419
…		…
289	my $name = $HOOKNAME[$htype];	443	my $name = $HOOKNAME[$htype];
290		444
291	my $ref = $pkg->can ("on_" . lc $name)	445	my $ref = $pkg->can ("on_" . lc $name)
292	or next;	446	or next;
293		447
294	$term->{_hook}[$htype]{$ref*1} = $ref;	448	$TERM->{_hook}[$htype]{$pkg} = $ref;
295	$hook_count[$htype]++	449	$hook_count[$htype]++
296	or set_should_invoke $htype, 1;	450	or set_should_invoke $htype, 1;
297	}	451	}
298	}	452	}
299		453
300	my $script_pkg = "script0000";	454	my $extension_pkg = "extension0000";
301	my %script_pkg;	455	my %extension_pkg;
302		456
303	# load a single script into its own package, once only	457	# load a single script into its own package, once only
304	sub script_package($) {	458	sub extension_package($) {
305	my ($path) = @_;	459	my ($path) = @_;
306		460
307	$script_pkg{$path} \|\|= do {	461	$extension_pkg{$path} \|\|= do {
308	my $pkg = "urxvt::" . ($script_pkg++);	462	my $pkg = "urxvt::" . ($extension_pkg++);
309		463
310	verbose 3, "loading script '$path' into package '$pkg'";	464	verbose 3, "loading extension '$path' into package '$pkg'";
311		465
312	open my $fh, "<:raw", $path	466	open my $fh, "<:raw", $path
313	or die "$path: $!";	467	or die "$path: $!";
314		468
315	my $source = "package $pkg; use strict; use utf8;\n"	469	my $source = "package $pkg; use strict; use utf8;\n"
		470	. "use base urxvt::term::proxy::;\n"
316	. "#line 1 \"$path\"\n{\n"	471	. "#line 1 \"$path\"\n{\n"
317	. (do { local $/; <$fh> })	472	. (do { local $/; <$fh> })
318	. "\n};\n1";	473	. "\n};\n1";
319		474
320	eval $source or die "$path: $@";	475	eval $source or die "$path: $@";
321		476
322	$pkg	477	$pkg
323	}	478	}
324	}	479	}
325		480
		481	our $retval; # return value for urxvt
		482
326	# called by the rxvt core	483	# called by the rxvt core
327	sub invoke {	484	sub invoke {
328	local $term = shift;	485	local $TERM = shift;
329	my $htype = shift;	486	my $htype = shift;
330		487
331	if ($htype == 0) { # INIT	488	if ($htype == 0) { # INIT
332	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	489	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		490
		491	my %want_ext;
333		492
334	for my $ext (split /:/, $term->resource ("perl_ext")) {	493	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		494	if ($_ eq "default") {
		495	$want_ext{$_}++ for qw(selection option-popup);
		496	} elsif (/^-(.*)$/) {
		497	delete $want_ext{$1};
		498	} else {
		499	$want_ext{$_}++;
		500	}
		501	}
		502
		503	for my $ext (keys %want_ext) {
335	my @files = grep -f $_, map "$_/$ext", @dirs;	504	my @files = grep -f $_, map "$_/$ext", @dirs;
336		505
337	if (@files) {	506	if (@files) {
338	register_package script_package $files[0];	507	register_package extension_package $files[0];
339	} else {	508	} else {
340	warn "perl extension '$ext' not found in perl library search path\n";	509	warn "perl extension '$ext' not found in perl library search path\n";
341	}	510	}
342	}	511	}
		512	}
343		513
		514	$retval = undef;
		515
		516	if (my $cb = $TERM->{_hook}[$htype]) {
		517	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		518	if $verbosity >= 10;
		519
		520	keys %$cb;
		521
		522	while (my ($pkg, $cb) = each %$cb) {
		523	eval {
		524	$retval = $cb->(
		525	$TERM->{_pkg}{$pkg} \|\|= do {
		526	my $proxy = bless { }, $pkg;
		527	Scalar::Util::weaken ($proxy->{term} = $TERM);
		528	$proxy
		529	},
		530	@_,
		531	) and last;
		532	};
		533	warn $@ if $@;#d#
		534	}
		535	}
		536
344	} elsif ($htype == 1) { # DESTROY	537	if ($htype == 1) { # DESTROY
		538	# remove hooks if unused
345	if (my $hook = $term->{_hook}) {	539	if (my $hook = $TERM->{_hook}) {
346	for my $htype (0..$#$hook) {	540	for my $htype (0..$#$hook) {
347	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	541	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
348	or set_should_invoke $htype, 0;	542	or set_should_invoke $htype, 0;
349	}	543	}
350	}	544	}
		545
		546	# clear package objects
		547	%$_ = () for values %{ $TERM->{_pkg} };
		548
		549	# clear package
		550	%$TERM = ();
351	}	551	}
352		552
353	my $cb = $term->{_hook}[$htype]	553	$retval
354	or return;	554	}
355		555
356	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	556	sub urxvt::term::proxy::AUTOLOAD {
357	if $verbosity >= 10;	557	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		558	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
358		559
359	while (my ($k, $v) = each %$cb) {	560	eval qq{
360	return 1 if $v->($term, @_);	561	sub $urxvt::term::proxy::AUTOLOAD {
361	}	562	my \$proxy = shift;
		563	\$proxy->{term}->$1 (\@_)
		564	}
		565	1
		566	} or die "FATAL: unable to compile method forwarder: $@";
362		567
363	0	568	goto &$urxvt::term::proxy::AUTOLOAD;
		569	}
		570
		571	sub urxvt::destroy_hook::DESTROY {
		572	${$_[0]}->();
		573	}
		574
		575	sub urxvt::destroy_hook(&) {
		576	bless \shift, urxvt::destroy_hook::
364	}	577	}
365		578
366	=head2 The C<urxvt::term> Class	579	=head2 The C<urxvt::term> Class
367		580
368	=over 4	581	=over 4
		582
		583	=item $term->destroy
		584
		585	Destroy the terminal object (close the window, free resources etc.).
		586
		587	=item $isset = $term->option ($optval[, $set])
		588
		589	Returns true if the option specified by C<$optval> is enabled, and
		590	optionally change it. All option values are stored by name in the hash
		591	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		592
		593	Here is a a likely non-exhaustive list of option names, please see the
		594	source file F</src/optinc.h> to see the actual list:
		595
		596	borderLess console cursorBlink cursorUnderline hold iconic insecure
		597	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		598	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		599	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		600	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		601	tripleclickwords utmpInhibit visualBell
369		602
370	=item $value = $term->resource ($name[, $newval])	603	=item $value = $term->resource ($name[, $newval])
371		604
372	Returns the current resource value associated with a given name and	605	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>	606	optionally sets a new value. Setting values is most useful in the C<init>
…		…
383		616
384	Please note that resource strings will currently only be freed when the	617	Please note that resource strings will currently only be freed when the
385	terminal is destroyed, so changing options frequently will eat memory.	618	terminal is destroyed, so changing options frequently will eat memory.
386		619
387	Here is a a likely non-exhaustive list of resource names, not all of which	620	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	621	are supported in every build, please see the source file F</src/rsinc.h>
389	list:	622	to see the actual list:
390		623
391	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	624	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
392	borderLess color cursorBlink cursorUnderline cutchars delete_key	625	borderLess color cursorBlink cursorUnderline cutchars delete_key
393	display_name embed ext_bwidth fade font geometry hold iconName	626	display_name embed ext_bwidth fade font geometry hold iconName
394	imFont imLocale inputMethod insecure int_bwidth intensityStyles	627	imFont imLocale inputMethod insecure int_bwidth intensityStyles
395	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	628	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
396	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	629	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
397	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	630	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
398	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	631	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
399	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	632	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
400	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	633	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
401	shade term_name title transparent transparent_all tripleclickwords	634	shade term_name title transparent transparent_all tripleclickwords
…		…
404	=cut	637	=cut
405		638
406	sub urxvt::term::resource($$;$) {	639	sub urxvt::term::resource($$;$) {
407	my ($self, $name) = (shift, shift);	640	my ($self, $name) = (shift, shift);
408	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	641	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
409	goto &urxvt::term::_resource;	642	&urxvt::term::_resource
410	}	643	}
		644
		645	=item $rend = $term->rstyle ([$new_rstyle])
		646
		647	Return and optionally change the current rendition. Text that is output by
		648	the terminal application will use this style.
		649
		650	=item ($row, $col) = $term->screen_cur ([$row, $col])
		651
		652	Return the current coordinates of the text cursor position and optionally
		653	set it (which is usually bad as applications don't expect that).
411		654
412	=item ($row, $col) = $term->selection_mark ([$row, $col])	655	=item ($row, $col) = $term->selection_mark ([$row, $col])
413		656
414	=item ($row, $col) = $term->selection_beg ([$row, $col])	657	=item ($row, $col) = $term->selection_beg ([$row, $col])
415		658
…		…
430	#=item $term->overlay ($x, $y, $text)	673	#=item $term->overlay ($x, $y, $text)
431	#	674	#
432	#Create a simple multi-line overlay box. See the next method for details.	675	#Create a simple multi-line overlay box. See the next method for details.
433	#	676	#
434	#=cut	677	#=cut
435		678	#
436	sub urxvt::term::scr_overlay {	679	#sub urxvt::term::scr_overlay {
437	die;
438	my ($self, $x, $y, $text) = @_;	680	# my ($self, $x, $y, $text) = @_;
439		681	#
440	my @lines = split /\n/, $text;	682	# my @lines = split /\n/, $text;
441		683	#
442	my $w = 0;	684	# my $w = 0;
443	for (map $self->strwidth ($_), @lines) {	685	# for (map $self->strwidth ($_), @lines) {
444	$w = $_ if $w < $_;	686	# $w = $_ if $w < $_;
445	}	687	# }
446		688	#
447	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	689	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
448	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	690	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
449	}	691	#}
450		692
451	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	693	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
452		694
453	Create a new (empty) overlay at the given position with the given	695	Create a new (empty) overlay at the given position with the given
454	width/height. C<$rstyle> defines the initial rendition style	696	width/height. C<$rstyle> defines the initial rendition style
…		…
461	right/bottom side, respectively.	703	right/bottom side, respectively.
462		704
463	This method returns an urxvt::overlay object. The overlay will be visible	705	This method returns an urxvt::overlay object. The overlay will be visible
464	as long as the perl object is referenced.	706	as long as the perl object is referenced.
465		707
466	Currently, the only method on the C<urxvt::overlay> object is C<set>:	708	The methods currently supported on C<urxvt::overlay> objects are:
		709
		710	=over 4
467		711
468	=item $overlay->set ($x, $y, $text, $rend)	712	=item $overlay->set ($x, $y, $text, $rend)
469		713
470	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	714	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	715	text in rxvt-unicode's special encoding and an array of rendition values
472	at a specific position inside the overlay.	716	at a specific position inside the overlay.
473		717
		718	=item $overlay->hide
		719
		720	If visible, hide the overlay, but do not destroy it.
		721
		722	=item $overlay->show
		723
		724	If hidden, display the overlay again.
		725
		726	=back
		727
		728	=item $popup = $term->popup ($event)
		729
		730	Creates a new C<urxvt::popup> object that implements a popup menu. The
		731	C<$event> I<must> be the event causing the menu to pop up (a button event,
		732	currently).
		733
		734	=cut
		735
		736	sub urxvt::term::popup {
		737	my ($self, $event) = @_;
		738
		739	$self->grab ($event->{time}, 1)
		740	or return;
		741
		742	my $popup = bless {
		743	term => $self,
		744	event => $event,
		745	}, urxvt::popup::;
		746
		747	Scalar::Util::weaken $popup->{term};
		748
		749	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		750	Scalar::Util::weaken $self->{_destroy}{$popup};
		751
		752	$popup
		753	}
		754
474	=item $cellwidth = $term->strwidth $string	755	=item $cellwidth = $term->strwidth ($string)
475		756
476	Returns the number of screen-cells this string would need. Correctly	757	Returns the number of screen-cells this string would need. Correctly
477	accounts for wide and combining characters.	758	accounts for wide and combining characters.
478		759
479	=item $octets = $term->locale_encode $string	760	=item $octets = $term->locale_encode ($string)
480		761
481	Convert the given text string into the corresponding locale encoding.	762	Convert the given text string into the corresponding locale encoding.
482		763
483	=item $string = $term->locale_decode $octets	764	=item $string = $term->locale_decode ($octets)
484		765
485	Convert the given locale-encoded octets into a perl string.	766	Convert the given locale-encoded octets into a perl string.
		767
		768	=item $term->scr_add_lines ($string)
		769
		770	Write the given text string to the screen, as if output by the application
		771	running inside the terminal. It may not contain command sequences (escape
		772	codes), but is free to use line feeds, carriage returns and tabs. The
		773	string is a normal text string, not in locale-dependent encoding.
		774
		775	Normally its not a good idea to use this function, as programs might be
		776	confused by changes in cursor position or scrolling. Its useful inside a
		777	C<on_add_lines> hook, though.
		778
		779	=item $term->cmd_parse ($octets)
		780
		781	Similar to C<scr_add_lines>, but the argument must be in the
		782	locale-specific encoding of the terminal and can contain command sequences
		783	(escape codes) that will be interpreted.
486		784
487	=item $term->tt_write ($octets)	785	=item $term->tt_write ($octets)
488		786
489	Write the octets given in C<$data> to the tty (i.e. as program input). To	787	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	788	pass characters instead of octets, you should convert your strings first
491	to the locale-specific encoding using C<< $term->locale_encode >>.	789	to the locale-specific encoding using C<< $term->locale_encode >>.
492		790
		791	=item $windowid = $term->parent
		792
		793	Return the window id of the toplevel window.
		794
		795	=item $windowid = $term->vt
		796
		797	Return the window id of the terminal window.
		798
		799	=item $window_width = $term->width
		800
		801	=item $window_height = $term->height
		802
		803	=item $font_width = $term->fwidth
		804
		805	=item $font_height = $term->fheight
		806
		807	=item $font_ascent = $term->fbase
		808
493	=item $nrow = $term->nrow	809	=item $terminal_rows = $term->nrow
494		810
495	=item $ncol = $term->ncol	811	=item $terminal_columns = $term->ncol
496		812
497	Return the number of rows/columns of the terminal window (i.e. as	813	=item $has_focus = $term->focus
498	specified by C<-geometry>, excluding any scrollback).
499		814
500	=item $nsaved = $term->nsaved	815	=item $is_mapped = $term->mapped
501		816
502	Returns the number of lines in the scrollback buffer.	817	=item $max_scrollback = $term->saveLines
		818
		819	=item $nrow_plus_saveLines = $term->total_rows
		820
		821	=item $lines_in_scrollback = $term->nsaved
		822
		823	Return various integers describing terminal characteristics.
		824
		825	=item $modifiermask = $term->ModLevel3Mask
		826
		827	=item $modifiermask = $term->ModMetaMask
		828
		829	=item $modifiermask = $term->ModNumLockMask
		830
		831	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		832	AltGr), the meta key (often Alt) and the num lock key, if applicable.
503		833
504	=item $view_start = $term->view_start ([$newvalue])	834	=item $view_start = $term->view_start ([$newvalue])
505		835
506	Returns the negative row number of the topmost line. Minimum value is	836	Returns the negative row number of the topmost line. Minimum value is
507	C<0>, which displays the normal terminal contents. Larger values scroll	837	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
518	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	848	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
519		849
520	Returns the text of the entire row with number C<$row_number>. Row C<0>	850	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	851	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	852	terminal line. The scrollback buffer starts at line C<-1> and extends to
523	line C<< -$term->nsaved >>.	853	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		854	is requested.
524		855
525	If C<$new_text> is specified, it will replace characters in the current	856	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	857	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	858	to replace only parts of a line. The font index in the rendition will
528	automatically be updated.	859	automatically be updated.
…		…
550		881
551	See the section on RENDITION, above.	882	See the section on RENDITION, above.
552		883
553	=item $length = $term->ROW_l ($row_number[, $new_length])	884	=item $length = $term->ROW_l ($row_number[, $new_length])
554		885
555	Returns the number of screen cells that are in use ("the line length"). If	886	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	887	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.	888	line is joined with the following one.
558		889
		890	=item $bool = $term->is_longer ($row_number)
		891
		892	Returns true if the row is part of a multiple-row logical "line" (i.e.
		893	joined with the following row), which means all characters are in use
		894	and it is continued on the next row (and possibly a continuation of the
		895	previous row(s)).
		896
		897	=item $line = $term->line ($row_number)
		898
		899	Create and return a new C<urxvt::line> object that stores information
		900	about the logical line that row C<$row_number> is part of. It supports the
		901	following methods:
		902
		903	=over 4
		904
		905	=item $text = $line->t ([$new_text])
		906
		907	Returns or replaces the full text of the line, similar to C<ROW_t>
		908
		909	=item $rend = $line->r ([$new_rend])
		910
		911	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		912
		913	=item $length = $line->l
		914
		915	Returns the length of the line in cells, similar to C<ROW_l>.
		916
		917	=item $rownum = $line->beg
		918
		919	=item $rownum = $line->end
		920
		921	Return the row number of the first/last row of the line, respectively.
		922
		923	=item $offset = $line->offset_of ($row, $col)
		924
		925	Returns the character offset of the given row\|col pair within the logical
		926	line.
		927
		928	=item ($row, $col) = $line->coord_of ($offset)
		929
		930	Translates a string offset into terminal coordinates again.
		931
		932	=back
		933
		934	=cut
		935
		936	sub urxvt::term::line {
		937	my ($self, $row) = @_;
		938
		939	my $maxrow = $self->nrow - 1;
		940
		941	my ($beg, $end) = ($row, $row);
		942
		943	--$beg while $self->ROW_is_longer ($beg - 1);
		944	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		945
		946	bless {
		947	term => $self,
		948	beg => $beg,
		949	end => $end,
		950	ncol => $self->ncol,
		951	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		952	}, urxvt::line::
		953	}
		954
		955	sub urxvt::line::t {
		956	my ($self) = @_;
		957
		958	if (@_ > 1)
		959	{
		960	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		961	for $self->{beg} .. $self->{end};
		962	}
		963
		964	defined wantarray &&
		965	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		966	0, $self->{len}
		967	}
		968
		969	sub urxvt::line::r {
		970	my ($self) = @_;
		971
		972	if (@_ > 1)
		973	{
		974	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		975	for $self->{beg} .. $self->{end};
		976	}
		977
		978	if (defined wantarray) {
		979	my $rend = [
		980	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		981	];
		982	$#$rend = $self->{len} - 1;
		983	return $rend;
		984	}
		985
		986	()
		987	}
		988
		989	sub urxvt::line::beg { $_[0]{beg} }
		990	sub urxvt::line::end { $_[0]{end} }
		991	sub urxvt::line::l { $_[0]{len} }
		992
		993	sub urxvt::line::offset_of {
		994	my ($self, $row, $col) = @_;
		995
		996	($row - $self->{beg}) * $self->{ncol} + $col
		997	}
		998
		999	sub urxvt::line::coord_of {
		1000	my ($self, $offset) = @_;
		1001
		1002	use integer;
		1003
		1004	(
		1005	$offset / $self->{ncol} + $self->{beg},
		1006	$offset % $self->{ncol}
		1007	)
		1008	}
		1009
		1010	=item ($row, $col) = $line->coord_of ($offset)
559	=item $text = $term->special_encode $string	1011	=item $text = $term->special_encode $string
560		1012
561	Converts a perl string into the special encoding used by rxvt-unicode,	1013	Converts a perl string into the special encoding used by rxvt-unicode,
562	where one character corresponds to one screen cell. See	1014	where one character corresponds to one screen cell. See
563	C<< $term->ROW_t >> for details.	1015	C<< $term->ROW_t >> for details.
…		…
566		1018
567	Converts rxvt-unicodes text reprsentation into a perl string. See	1019	Converts rxvt-unicodes text reprsentation into a perl string. See
568	C<< $term->ROW_t >> for details.	1020	C<< $term->ROW_t >> for details.
569		1021
570	=back	1022	=back
		1023
		1024	=head2 The C<urxvt::popup> Class
		1025
		1026	=over 4
		1027
		1028	=cut
		1029
		1030	package urxvt::popup;
		1031
		1032	sub add_item {
		1033	my ($self, $item) = @_;
		1034
		1035	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1036	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1037	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1038
		1039	$item->{render} \|\|= sub { $_[0]{text} };
		1040
		1041	push @{ $self->{item} }, $item;
		1042	}
		1043
		1044	sub add_separator {
		1045	my ($self, $sep) = @_;
		1046
		1047	$sep \|\|= "═";
		1048
		1049	$self->add_item ({
		1050	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1051	text => "",
		1052	render => sub { $sep x $urxvt::TERM->ncol },
		1053	activate => sub { },
		1054	});
		1055	}
		1056
		1057	sub add_title {
		1058	my ($self, $title) = @_;
		1059
		1060	$self->add_item ({
		1061	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1062	text => $title,
		1063	activate => sub { },
		1064	});
		1065	}
		1066
		1067	sub add_button {
		1068	my ($self, $text, $cb) = @_;
		1069
		1070	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1071	}
		1072
		1073	sub add_toggle {
		1074	my ($self, $text, $cb, $value) = @_;
		1075
		1076	my $item; $item = {
		1077	type => "button",
		1078	text => " $text",
		1079	value => $value,
		1080	render => sub { ($item->{value} ? "* " : " ") . $text },
		1081	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1082	};
		1083
		1084	$self->add_item ($item);
		1085	}
		1086
		1087	sub show {
		1088	my ($self) = @_;
		1089
		1090	local $urxvt::popup::self = $self;
		1091
		1092	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1093	"--transient-for" => $self->{term}->parent,
		1094	"-pe" => "urxvt-popup")
		1095	or die "unable to create popup window\n";
		1096	}
		1097
		1098	sub DESTROY {
		1099	my ($self) = @_;
		1100
		1101	$self->{term}->ungrab;
		1102	}
571		1103
572	=head2 The C<urxvt::timer> Class	1104	=head2 The C<urxvt::timer> Class
573		1105
574	This class implements timer watchers/events. Time is represented as a	1106	This class implements timer watchers/events. Time is represented as a
575	fractional number of seconds since the epoch. Example:	1107	fractional number of seconds since the epoch. Example:
…		…
677	This variable controls the verbosity level of the perl extension. Higher	1209	This variable controls the verbosity level of the perl extension. Higher
678	numbers indicate more verbose output.	1210	numbers indicate more verbose output.
679		1211
680	=over 4	1212	=over 4
681		1213
682	=item 0 - only fatal messages	1214	=item =0 - only fatal messages
683		1215
684	=item 3 - script loading and management	1216	=item =3 - script loading and management
685		1217
686	=item 10 - all events received	1218	=item =10 - all events received
687		1219
688	=back	1220	=back
689		1221
690	=head1 AUTHOR	1222	=head1 AUTHOR
691		1223

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC vs. Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC