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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.25 by root, Tue Jan 3 21:08:39 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	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
…		…
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	126	The following subroutines can be declared in extension files, and will be
87	called whenever the relevant event happens.	127	called whenever the relevant event happens.
88		128
89	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
90	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
91	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>
92	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>
93	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.
94		135
95	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
96	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,
97	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.
98		139
…		…
101	=over 4	142	=over 4
102		143
103	=item on_init $term	144	=item on_init $term
104		145
105	Called after a new terminal object has been initialized, but before	146	Called after a new terminal object has been initialized, but before
106	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.
107		151
108	=item on_reset $term	152	=item on_reset $term
109		153
110	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
111	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
…		…
140	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
141	processing.	185	processing.
142		186
143	See the F<selection> example extension.	187	See the F<selection> example extension.
144		188
145	=item on_focus_in $term
146
147	Called whenever the window gets the keyboard focus, before urxvt does
148	focus in processing.
149
150	=item on_focus_out $term
151
152	Called wheneever the window loses keyboard focus, before urxvt does focus
153	out processing.
154
155	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
156		190
157	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
158	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
159	show this many lines of scrollback.	193	show this many lines of scrollback.
…		…
169	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
170		204
171	=item on_tty_activity $term NYI	205	=item on_tty_activity $term NYI
172		206
173	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.
174		243
175	=item on_refresh_begin $term	244	=item on_refresh_begin $term
176		245
177	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
178	or similar effects by modify terminal contents in refresh_begin, and	247	or similar effects by modify terminal contents in refresh_begin, and
…		…
187		256
188	Called whenever the user presses a key combination that has a	257	Called whenever the user presses a key combination that has a
189	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>
190	resource in the @@RXVT_NAME@@(1) manpage).	259	resource in the @@RXVT_NAME@@(1) manpage).
191		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
192	=back	297	=back
193		298
194	=head2 Variables in the C<urxvt> Package	299	=head2 Variables in the C<urxvt> Package
195		300
196	=over 4	301	=over 4
197		302
198	=item $urxvt::TERM	303	=item $urxvt::TERM
199		304
200	The current terminal. Whenever a callback/Hook is bein executed, this	305	The current terminal. This variable stores the current C<urxvt::term>
201	variable stores the current C<urxvt::term> object.	306	object, whenever a callback/hook is executing.
202		307
203	=back	308	=back
204		309
205	=head2 Functions in the C<urxvt> Package	310	=head2 Functions in the C<urxvt> Package
206		311
207	=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.
208		321
209	=item urxvt::fatal $errormessage	322	=item urxvt::fatal $errormessage
210		323
211	Fatally aborts execution with the given error message. Avoid at all	324	Fatally aborts execution with the given error message. Avoid at all
212	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
…		…
222	correct place, e.g. on stderr of the connecting urxvtc client.	335	correct place, e.g. on stderr of the connecting urxvtc client.
223		336
224	=item $time = urxvt::NOW	337	=item $time = urxvt::NOW
225		338
226	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.
227		348
228	=back	349	=back
229		350
230	=head2 RENDITION	351	=head2 RENDITION
231		352
…		…
281		402
282	=cut	403	=cut
283		404
284	package urxvt;	405	package urxvt;
285		406
		407	use utf8;
286	use strict;	408	use strict;
287	use Scalar::Util ();	409	use Scalar::Util ();
		410	use List::Util ();
288		411
289	our $TERM;	412	our $TERM;
290	our @HOOKNAME;	413	our @HOOKNAME;
		414	our %OPTION;
291	our $LIBDIR;	415	our $LIBDIR;
292		416
293	BEGIN {	417	BEGIN {
294	urxvt->bootstrap;	418	urxvt->bootstrap;
295		419
…		…
325	$hook_count[$htype]++	449	$hook_count[$htype]++
326	or set_should_invoke $htype, 1;	450	or set_should_invoke $htype, 1;
327	}	451	}
328	}	452	}
329		453
330	my $script_pkg = "script0000";	454	my $extension_pkg = "extension0000";
331	my %script_pkg;	455	my %extension_pkg;
332		456
333	# load a single script into its own package, once only	457	# load a single script into its own package, once only
334	sub script_package($) {	458	sub extension_package($) {
335	my ($path) = @_;	459	my ($path) = @_;
336		460
337	$script_pkg{$path} \|\|= do {	461	$extension_pkg{$path} \|\|= do {
338	my $pkg = "urxvt::" . ($script_pkg++);	462	my $pkg = "urxvt::" . ($extension_pkg++);
339		463
340	verbose 3, "loading script '$path' into package '$pkg'";	464	verbose 3, "loading extension '$path' into package '$pkg'";
341		465
342	open my $fh, "<:raw", $path	466	open my $fh, "<:raw", $path
343	or die "$path: $!";	467	or die "$path: $!";
344		468
345	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"
346	. "#line 1 \"$path\"\n{\n"	471	. "#line 1 \"$path\"\n{\n"
347	. (do { local $/; <$fh> })	472	. (do { local $/; <$fh> })
348	. "\n};\n1";	473	. "\n};\n1";
349		474
350	eval $source or die "$path: $@";	475	eval $source or die "$path: $@";
351		476
352	$pkg	477	$pkg
353	}	478	}
354	}	479	}
		480
		481	our $retval; # return value for urxvt
355		482
356	# called by the rxvt core	483	# called by the rxvt core
357	sub invoke {	484	sub invoke {
358	local $TERM = shift;	485	local $TERM = shift;
359	my $htype = shift;	486	my $htype = shift;
360		487
361	if ($htype == 0) { # INIT	488	if ($htype == 0) { # INIT
362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	489	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		490
		491	my %want_ext;
363		492
364	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) {
365	my @files = grep -f $_, map "$_/$ext", @dirs;	504	my @files = grep -f $_, map "$_/$ext", @dirs;
366		505
367	if (@files) {	506	if (@files) {
368	register_package script_package $files[0];	507	register_package extension_package $files[0];
369	} else {	508	} else {
370	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";
371	}	510	}
372	}	511	}
		512	}
373		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
374	} elsif ($htype == 1) { # DESTROY	537	if ($htype == 1) { # DESTROY
		538	# remove hooks if unused
375	if (my $hook = $TERM->{_hook}) {	539	if (my $hook = $TERM->{_hook}) {
376	for my $htype (0..$#$hook) {	540	for my $htype (0..$#$hook) {
377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	541	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
378	or set_should_invoke $htype, 0;	542	or set_should_invoke $htype, 0;
379	}	543	}
380	}	544	}
		545
		546	# clear package objects
		547	%$_ = () for values %{ $TERM->{_pkg} };
		548
		549	# clear package
		550	%$TERM = ();
381	}	551	}
382		552
383	my $cb = $TERM->{_hook}[$htype]	553	$retval
384	or return;
385
386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
387	if $verbosity >= 10;
388
389	keys %$cb;
390
391	while (my ($pkg, $cb) = each %$cb) {
392	return 1
393	if $cb->(
394	$TERM->{$pkg} \|\|= do {
395	my $proxy = bless { }, urxvt::term::proxy::;
396	Scalar::Util::weaken ($proxy->{term} = $TERM);
397	$proxy
398	},
399	@_,
400	);
401	}
402
403	0
404	}	554	}
405		555
406	sub urxvt::term::proxy::AUTOLOAD {	556	sub urxvt::term::proxy::AUTOLOAD {
407	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	557	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
408	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	558	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
…		…
416	} or die "FATAL: unable to compile method forwarder: $@";	566	} or die "FATAL: unable to compile method forwarder: $@";
417		567
418	goto &$urxvt::term::proxy::AUTOLOAD;	568	goto &$urxvt::term::proxy::AUTOLOAD;
419	}	569	}
420		570
		571	sub urxvt::destroy_hook::DESTROY {
		572	${$_[0]}->();
		573	}
		574
		575	sub urxvt::destroy_hook(&) {
		576	bless \shift, urxvt::destroy_hook::
		577	}
		578
421	=head2 The C<urxvt::term> Class	579	=head2 The C<urxvt::term> Class
422		580
423	=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
424		602
425	=item $value = $term->resource ($name[, $newval])	603	=item $value = $term->resource ($name[, $newval])
426		604
427	Returns the current resource value associated with a given name and	605	Returns the current resource value associated with a given name and
428	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>
…		…
438		616
439	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
440	terminal is destroyed, so changing options frequently will eat memory.	618	terminal is destroyed, so changing options frequently will eat memory.
441		619
442	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
443	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>
444	list:	622	to see the actual list:
445		623
446	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	624	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447	borderLess color cursorBlink cursorUnderline cutchars delete_key	625	borderLess color cursorBlink cursorUnderline cutchars delete_key
448	display_name embed ext_bwidth fade font geometry hold iconName	626	display_name embed ext_bwidth fade font geometry hold iconName
449	imFont imLocale inputMethod insecure int_bwidth intensityStyles	627	imFont imLocale inputMethod insecure int_bwidth intensityStyles
450	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	628	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
451	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	629	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
452	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	630	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
453	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	631	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
454	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	632	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
455	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	633	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
456	shade term_name title transparent transparent_all tripleclickwords	634	shade term_name title transparent transparent_all tripleclickwords
…		…
459	=cut	637	=cut
460		638
461	sub urxvt::term::resource($$;$) {	639	sub urxvt::term::resource($$;$) {
462	my ($self, $name) = (shift, shift);	640	my ($self, $name) = (shift, shift);
463	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	641	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
464	goto &urxvt::term::_resource;	642	&urxvt::term::_resource
465	}	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).
466		654
467	=item ($row, $col) = $term->selection_mark ([$row, $col])	655	=item ($row, $col) = $term->selection_mark ([$row, $col])
468		656
469	=item ($row, $col) = $term->selection_beg ([$row, $col])	657	=item ($row, $col) = $term->selection_beg ([$row, $col])
470		658
…		…
485	#=item $term->overlay ($x, $y, $text)	673	#=item $term->overlay ($x, $y, $text)
486	#	674	#
487	#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.
488	#	676	#
489	#=cut	677	#=cut
490		678	#
491	sub urxvt::term::scr_overlay {	679	#sub urxvt::term::scr_overlay {
492	die;
493	my ($self, $x, $y, $text) = @_;	680	# my ($self, $x, $y, $text) = @_;
494		681	#
495	my @lines = split /\n/, $text;	682	# my @lines = split /\n/, $text;
496		683	#
497	my $w = 0;	684	# my $w = 0;
498	for (map $self->strwidth ($_), @lines) {	685	# for (map $self->strwidth ($_), @lines) {
499	$w = $_ if $w < $_;	686	# $w = $_ if $w < $_;
500	}	687	# }
501		688	#
502	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	689	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
503	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	690	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
504	}	691	#}
505		692
506	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	693	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
507		694
508	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
509	width/height. C<$rstyle> defines the initial rendition style	696	width/height. C<$rstyle> defines the initial rendition style
…		…
536		723
537	If hidden, display the overlay again.	724	If hidden, display the overlay again.
538		725
539	=back	726	=back
540		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
541	=item $cellwidth = $term->strwidth $string	755	=item $cellwidth = $term->strwidth ($string)
542		756
543	Returns the number of screen-cells this string would need. Correctly	757	Returns the number of screen-cells this string would need. Correctly
544	accounts for wide and combining characters.	758	accounts for wide and combining characters.
545		759
546	=item $octets = $term->locale_encode $string	760	=item $octets = $term->locale_encode ($string)
547		761
548	Convert the given text string into the corresponding locale encoding.	762	Convert the given text string into the corresponding locale encoding.
549		763
550	=item $string = $term->locale_decode $octets	764	=item $string = $term->locale_decode ($octets)
551		765
552	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.
553		784
554	=item $term->tt_write ($octets)	785	=item $term->tt_write ($octets)
555		786
556	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
557	pass characters instead of octets, you should convert your strings first	788	pass characters instead of octets, you should convert your strings first
558	to the locale-specific encoding using C<< $term->locale_encode >>.	789	to the locale-specific encoding using C<< $term->locale_encode >>.
559		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
560	=item $nrow = $term->nrow	809	=item $terminal_rows = $term->nrow
561		810
562	=item $ncol = $term->ncol	811	=item $terminal_columns = $term->ncol
563		812
564	Return the number of rows/columns of the terminal window (i.e. as	813	=item $has_focus = $term->focus
565	specified by C<-geometry>, excluding any scrollback).
566		814
567	=item $nsaved = $term->nsaved	815	=item $is_mapped = $term->mapped
568		816
569	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.
570		833
571	=item $view_start = $term->view_start ([$newvalue])	834	=item $view_start = $term->view_start ([$newvalue])
572		835
573	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
574	C<0>, which displays the normal terminal contents. Larger values scroll	837	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
637	about the logical line that row C<$row_number> is part of. It supports the	900	about the logical line that row C<$row_number> is part of. It supports the
638	following methods:	901	following methods:
639		902
640	=over 4	903	=over 4
641		904
642	=item $text = $line->t	905	=item $text = $line->t ([$new_text])
643		906
644	Returns the full text of the line, similar to C<ROW_t>	907	Returns or replaces the full text of the line, similar to C<ROW_t>
645		908
646	=item $rend = $line->r	909	=item $rend = $line->r ([$new_rend])
647		910
648	Returns the full rendition array of the line, similar to C<ROW_r>	911	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
649		912
650	=item $length = $line->l	913	=item $length = $line->l
651		914
652	Returns the length of the line in cells, similar to C<ROW_l>.	915	Returns the length of the line in cells, similar to C<ROW_l>.
653		916
…		…
682		945
683	bless {	946	bless {
684	term => $self,	947	term => $self,
685	beg => $beg,	948	beg => $beg,
686	end => $end,	949	end => $end,
		950	ncol => $self->ncol,
687	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	951	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
688	}, urxvt::line::	952	}, urxvt::line::
689	}	953	}
690		954
691	sub urxvt::line::t {	955	sub urxvt::line::t {
692	my ($self) = @_;	956	my ($self) = @_;
693		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 &&
694	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	965	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
695	0, $self->{len}	966	0, $self->{len}
696	}	967	}
697		968
698	sub urxvt::line::r {	969	sub urxvt::line::r {
699	my ($self) = @_;	970	my ($self) = @_;
700		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) {
701	my $rend = [	979	my $rend = [
702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	980	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
703	];	981	];
704	$#$rend = $self->{len} - 1;	982	$#$rend = $self->{len} - 1;
705	$rend	983	return $rend;
		984	}
		985
		986	()
706	}	987	}
707		988
708	sub urxvt::line::beg { $_[0]{beg} }	989	sub urxvt::line::beg { $_[0]{beg} }
709	sub urxvt::line::end { $_[0]{end} }	990	sub urxvt::line::end { $_[0]{end} }
710	sub urxvt::line::l { $_[0]{len} }	991	sub urxvt::line::l { $_[0]{len} }
711		992
712	sub urxvt::line::offset_of {	993	sub urxvt::line::offset_of {
713	my ($self, $row, $col) = @_;	994	my ($self, $row, $col) = @_;
714		995
715	($row - $self->{beg}) * $self->{term}->ncol + $col	996	($row - $self->{beg}) * $self->{ncol} + $col
716	}	997	}
717		998
718	sub urxvt::line::coord_of {	999	sub urxvt::line::coord_of {
719	my ($self, $offset) = @_;	1000	my ($self, $offset) = @_;
720		1001
721	use integer;	1002	use integer;
722		1003
723	(	1004	(
724	$offset / $self->{term}->ncol + $self->{beg},	1005	$offset / $self->{ncol} + $self->{beg},
725	$offset % $self->{term}->ncol	1006	$offset % $self->{ncol}
726	)	1007	)
727	}	1008	}
728		1009
729	=item ($row, $col) = $line->coord_of ($offset)	1010	=item ($row, $col) = $line->coord_of ($offset)
730	=item $text = $term->special_encode $string	1011	=item $text = $term->special_encode $string
…		…
737		1018
738	Converts rxvt-unicodes text reprsentation into a perl string. See	1019	Converts rxvt-unicodes text reprsentation into a perl string. See
739	C<< $term->ROW_t >> for details.	1020	C<< $term->ROW_t >> for details.
740		1021
741	=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	}
742		1103
743	=head2 The C<urxvt::timer> Class	1104	=head2 The C<urxvt::timer> Class
744		1105
745	This class implements timer watchers/events. Time is represented as a	1106	This class implements timer watchers/events. Time is represented as a
746	fractional number of seconds since the epoch. Example:	1107	fractional number of seconds since the epoch. Example:
…		…
848	This variable controls the verbosity level of the perl extension. Higher	1209	This variable controls the verbosity level of the perl extension. Higher
849	numbers indicate more verbose output.	1210	numbers indicate more verbose output.
850		1211
851	=over 4	1212	=over 4
852		1213
853	=item 0 - only fatal messages	1214	=item =0 - only fatal messages
854		1215
855	=item 3 - script loading and management	1216	=item =3 - script loading and management
856		1217
857	=item 10 - all events received	1218	=item =10 - all events received
858		1219
859	=back	1220	=back
860		1221
861	=head1 AUTHOR	1222	=head1 AUTHOR
862		1223

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.25 by root, Tue Jan 3 21:08:39 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.25 by root, Tue Jan 3 21:08:39 2006 UTC vs.
Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC