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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.26 by root, Tue Jan 3 21:22:22 2006 UTC vs.
Revision 1.49 by root, Sun Jan 8 00:07:18 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
…		…
59	=back	59	=back
60		60
61	=item digital-clock	61	=item digital-clock
62		62
63	Displays a digital clock using the built-in overlay.	63	Displays a digital clock using the built-in overlay.
		64
		65	=item mark-urls
		66
		67	Uses per-line display filtering (C<on_line_update>) to underline urls.
		68
		69	=item block-graphics-to-ascii
		70
		71	A not very useful example of filtering all text output to the terminal,
		72	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		73	similar-looking ascii character.
64		74
65	=item example-refresh-hooks	75	=item example-refresh-hooks
66		76
67	Displays a very simple digital clock in the upper right corner of the	77	Displays a very simple digital clock in the upper right corner of the
68	window. Illustrates overwriting the refresh callbacks to create your own	78	window. Illustrates overwriting the refresh callbacks to create your own
…		…
81	When objects are destroyed on the C++ side, the perl object hashes are	91	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	92	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	93	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	94	terminal is destroyed.
85		95
		96	Argument names also often indicate the type of a parameter. Here are some
		97	hints on what they mean:
		98
		99	=over 4
		100
		101	=item $text
		102
		103	Rxvt-unicodes special way of encoding text, where one "unicode" character
		104	always represents one screen cell. See L<row_t> for a discussion of this format.
		105
		106	=item $string
		107
		108	A perl text string, with an emphasis on I<text>. It can store all unicode
		109	characters and is to be distinguished with text encoded in a specific
		110	encoding (often locale-specific) and binary data.
		111
		112	=item $octets
		113
		114	Either binary data or - more common - a text string encoded in a
		115	locale-specific way.
		116
		117	=back
		118
86	=head2 Hooks	119	=head2 Hooks
87		120
88	The following subroutines can be declared in loaded scripts, and will be	121	The following subroutines can be declared in extension files, and will be
89	called whenever the relevant event happens.	122	called whenever the relevant event happens.
90		123
91	The first argument passed to them is an object private to each terminal	124	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	125	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>	126	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>	127	object that is shared between all packages is stored in the C<term>
95	member.	128	member. It is, however, blessed intot he package of the extension script,
		129	so for all practical purposes you can treat an extension script as a class.
96		130
97	All of them must return a boolean value. If it is true, then the event	131	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,	132	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.	133	and the relevant action might not be carried out by the C++ code.
100		134
…		…
103	=over 4	137	=over 4
104		138
105	=item on_init $term	139	=item on_init $term
106		140
107	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
108	windows are created or the command gets run.	142	windows are created or the command gets run. Most methods are unsafe to
		143	call or deliver senseless data, as terminal size and other characteristics
		144	have not yet been determined. You can safely query and change resources,
		145	though.
109		146
110	=item on_reset $term	147	=item on_reset $term
111		148
112	Called after the screen is "reset" for any reason, such as resizing or	149	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	150	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	179	should extend the selection itelf and return true to suppress the built-in
143	processing.	180	processing.
144		181
145	See the F<selection> example extension.	182	See the F<selection> example extension.
146		183
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	184	=item on_view_change $term, $offset
158		185
159	Called whenever the view offset changes, i..e the user or program	186	Called whenever the view offset changes, i..e the user or program
160	scrolls. Offset C<0> means display the normal terminal, positive values	187	scrolls. Offset C<0> means display the normal terminal, positive values
161	show this many lines of scrollback.	188	show this many lines of scrollback.
…		…
171	number of lines that will be in the scrollback buffer.	198	number of lines that will be in the scrollback buffer.
172		199
173	=item on_tty_activity $term NYI	200	=item on_tty_activity $term NYI
174		201
175	Called whenever the program(s) running in the urxvt window send output.	202	Called whenever the program(s) running in the urxvt window send output.
		203
		204	=item on_osc_seq $term, $string
		205
		206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		207	operating system command) is processed. Cursor position and other state
		208	information is up-to-date when this happens. For interoperability, the
		209	string should start with the extension name and a colon, to distinguish
		210	it from commands for other extensions, and this might be enforced in the
		211	future.
		212
		213	Be careful not ever to trust (in a security sense) the data you receive,
		214	as its source can not easily be controleld (e-mail content, messages from
		215	other users on the same system etc.).
		216
		217	=item on_add_lines $term, $string
		218
		219	Called whenever text is about to be output, with the text as argument. You
		220	can filter/change and output the text yourself by returning a true value
		221	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		222	might be very slow, however, as your hook is called for B<all> text being
		223	output.
		224
		225	=item on_line_update $term, $row
		226
		227	Called whenever a line was updated or changed. Can be used to filter
		228	screen output (e.g. underline urls or other useless stuff). Only lines
		229	that are being shown will be filtered, and, due to performance reasons,
		230	not always immediately.
		231
		232	The row number is always the topmost row of the line if the line spans
		233	multiple rows.
		234
		235	Please note that, if you change the line, then the hook might get called
		236	later with the already-modified line (e.g. if unrelated parts change), so
		237	you cannot just toggle rendition bits, but only set them.
176		238
177	=item on_refresh_begin $term	239	=item on_refresh_begin $term
178		240
179	Called just before the screen gets redrawn. Can be used for overlay	241	Called just before the screen gets redrawn. Can be used for overlay
180	or similar effects by modify terminal contents in refresh_begin, and	242	or similar effects by modify terminal contents in refresh_begin, and
…		…
189		251
190	Called whenever the user presses a key combination that has a	252	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>	253	C<perl:string> action bound to it (see description of the B<keysym>
192	resource in the @@RXVT_NAME@@(1) manpage).	254	resource in the @@RXVT_NAME@@(1) manpage).
193		255
		256	=item on_focus_in $term
		257
		258	Called whenever the window gets the keyboard focus, before rxvt-unicode
		259	does focus in processing.
		260
		261	=item on_focus_out $term
		262
		263	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		264	focus out processing.
		265
		266	=item on_key_press $term, $event, $octets
		267
		268	=item on_key_release $term, $event
		269
		270	=item on_button_press $term, $event
		271
		272	=item on_button_release $term, $event
		273
		274	=item on_motion_notify $term, $event
		275
		276	=item on_map_notify $term, $event
		277
		278	=item on_unmap_notify $term, $event
		279
		280	Called whenever the corresponding X event is received for the terminal If
		281	the hook returns true, then the even will be ignored by rxvt-unicode.
		282
		283	The event is a hash with most values as named by Xlib (see the XEvent
		284	manpage), with the additional members C<row> and C<col>, which are the row
		285	and column under the mouse cursor.
		286
		287	C<on_key_press> additionally receives the string rxvt-unicode would
		288	output, if any, in locale-specific encoding.
		289
		290	subwindow.
		291
194	=back	292	=back
195		293
196	=head2 Variables in the C<urxvt> Package	294	=head2 Variables in the C<urxvt> Package
197		295
198	=over 4	296	=over 4
199		297
200	=item $urxvt::TERM	298	=item $urxvt::TERM
201		299
202	The current terminal. Whenever a callback/Hook is bein executed, this	300	The current terminal. This variable stores the current C<urxvt::term>
203	variable stores the current C<urxvt::term> object.	301	object, whenever a callback/hook is executing.
204		302
205	=back	303	=back
206		304
207	=head2 Functions in the C<urxvt> Package	305	=head2 Functions in the C<urxvt> Package
208		306
209	=over 4	307	=over 4
		308
		309	=item $term = new urxvt [arg...]
		310
		311	Creates a new terminal, very similar as if you had started it with
		312	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		313	if the new instance couldn't be created. Returns C<undef> if the new
		314	instance didn't initialise perl, and the terminal object otherwise. The
		315	C<init> and C<start> hooks will be called during the call.
210		316
211	=item urxvt::fatal $errormessage	317	=item urxvt::fatal $errormessage
212		318
213	Fatally aborts execution with the given error message. Avoid at all	319	Fatally aborts execution with the given error message. Avoid at all
214	costs! The only time this is acceptable is when the terminal process	320	costs! The only time this is acceptable is when the terminal process
…		…
224	correct place, e.g. on stderr of the connecting urxvtc client.	330	correct place, e.g. on stderr of the connecting urxvtc client.
225		331
226	=item $time = urxvt::NOW	332	=item $time = urxvt::NOW
227		333
228	Returns the "current time" (as per the event loop).	334	Returns the "current time" (as per the event loop).
		335
		336	=item urxvt::CurrentTime
		337
		338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		340	Button4Mask, Button5Mask, AnyModifier
		341
		342	Various constants for use in X events.
229		343
230	=back	344	=back
231		345
232	=head2 RENDITION	346	=head2 RENDITION
233		347
…		…
283		397
284	=cut	398	=cut
285		399
286	package urxvt;	400	package urxvt;
287		401
		402	use utf8;
288	use strict;	403	use strict;
289	use Scalar::Util ();	404	use Scalar::Util ();
		405	use List::Util ();
290		406
291	our $TERM;	407	our $TERM;
292	our @HOOKNAME;	408	our @HOOKNAME;
		409	our %OPTION;
293	our $LIBDIR;	410	our $LIBDIR;
294		411
295	BEGIN {	412	BEGIN {
296	urxvt->bootstrap;	413	urxvt->bootstrap;
297		414
…		…
327	$hook_count[$htype]++	444	$hook_count[$htype]++
328	or set_should_invoke $htype, 1;	445	or set_should_invoke $htype, 1;
329	}	446	}
330	}	447	}
331		448
332	my $script_pkg = "script0000";	449	my $extension_pkg = "extension0000";
333	my %script_pkg;	450	my %extension_pkg;
334		451
335	# load a single script into its own package, once only	452	# load a single script into its own package, once only
336	sub script_package($) {	453	sub extension_package($) {
337	my ($path) = @_;	454	my ($path) = @_;
338		455
339	$script_pkg{$path} \|\|= do {	456	$extension_pkg{$path} \|\|= do {
340	my $pkg = "urxvt::" . ($script_pkg++);	457	my $pkg = "urxvt::" . ($extension_pkg++);
341		458
342	verbose 3, "loading script '$path' into package '$pkg'";	459	verbose 3, "loading extension '$path' into package '$pkg'";
343		460
344	open my $fh, "<:raw", $path	461	open my $fh, "<:raw", $path
345	or die "$path: $!";	462	or die "$path: $!";
346		463
347	my $source = "package $pkg; use strict; use utf8;\n"	464	my $source = "package $pkg; use strict; use utf8;\n"
		465	. "use base urxvt::term::proxy::;\n"
348	. "#line 1 \"$path\"\n{\n"	466	. "#line 1 \"$path\"\n{\n"
349	. (do { local $/; <$fh> })	467	. (do { local $/; <$fh> })
350	. "\n};\n1";	468	. "\n};\n1";
351		469
352	eval $source or die "$path: $@";	470	eval $source or die "$path: $@";
353		471
354	$pkg	472	$pkg
355	}	473	}
356	}	474	}
		475
		476	our $retval; # return value for urxvt
357		477
358	# called by the rxvt core	478	# called by the rxvt core
359	sub invoke {	479	sub invoke {
360	local $TERM = shift;	480	local $TERM = shift;
361	my $htype = shift;	481	my $htype = shift;
362		482
363	if ($htype == 0) { # INIT	483	if ($htype == 0) { # INIT
364	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	484	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
365		485
366	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	486	my @ext = (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2);
367	my @files = grep -f $_, map "$_/$ext", @dirs;
368		487
369	if (@files) {	488	while (@ext) {
370	register_package script_package $files[0];	489	my $ext = shift @ext;
		490	if ($ext eq "default") {
		491	unshift @ext, qw(selection);
371	} else {	492	} else {
		493	my @files = grep -f $_, map "$_/$ext", @dirs;
		494
		495	if (@files) {
		496	register_package extension_package $files[0];
		497	} else {
372	warn "perl extension '$ext' not found in perl library search path\n";	498	warn "perl extension '$ext' not found in perl library search path\n";
		499	}
373	}	500	}
374	}	501	}
		502	}
375		503
		504	$retval = undef;
		505
		506	if (my $cb = $TERM->{_hook}[$htype]) {
		507	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		508	if $verbosity >= 10;
		509
		510	keys %$cb;
		511
		512	while (my ($pkg, $cb) = each %$cb) {
		513	eval {
		514	$retval = $cb->(
		515	$TERM->{_pkg}{$pkg} \|\|= do {
		516	my $proxy = bless { }, $pkg;
		517	Scalar::Util::weaken ($proxy->{term} = $TERM);
		518	$proxy
		519	},
		520	@_,
		521	) and last;
		522	};
		523	warn $@ if $@;#d#
		524	}
		525	}
		526
376	} elsif ($htype == 1) { # DESTROY	527	if ($htype == 1) { # DESTROY
		528	# remove hooks if unused
377	if (my $hook = $TERM->{_hook}) {	529	if (my $hook = $TERM->{_hook}) {
378	for my $htype (0..$#$hook) {	530	for my $htype (0..$#$hook) {
379	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	531	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
380	or set_should_invoke $htype, 0;	532	or set_should_invoke $htype, 0;
381	}	533	}
382	}	534	}
		535
		536	# clear package objects
		537	%$_ = () for values %{ $TERM->{_pkg} };
		538
		539	# clear package
		540	%$TERM = ();
383	}	541	}
384		542
385	my $cb = $TERM->{_hook}[$htype]	543	$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	}	544	}
407		545
408	sub urxvt::term::proxy::AUTOLOAD {	546	sub urxvt::term::proxy::AUTOLOAD {
409	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	547	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
410	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	548	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
…		…
418	} or die "FATAL: unable to compile method forwarder: $@";	556	} or die "FATAL: unable to compile method forwarder: $@";
419		557
420	goto &$urxvt::term::proxy::AUTOLOAD;	558	goto &$urxvt::term::proxy::AUTOLOAD;
421	}	559	}
422		560
		561	sub urxvt::destroy_hook::DESTROY {
		562	${$_[0]}->();
		563	}
		564
		565	sub urxvt::destroy_hook(&) {
		566	bless \shift, urxvt::destroy_hook::
		567	}
		568
423	=head2 The C<urxvt::term> Class	569	=head2 The C<urxvt::term> Class
424		570
425	=over 4	571	=over 4
		572
		573	=item $term->destroy
		574
		575	Destroy the terminal object (close the window, free resources etc.).
		576
		577	=item $isset = $term->option ($optval[, $set])
		578
		579	Returns true if the option specified by C<$optval> is enabled, and
		580	optionally change it. All option values are stored by name in the hash
		581	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		582
		583	Here is a a likely non-exhaustive list of option names, please see the
		584	source file F</src/optinc.h> to see the actual list:
		585
		586	borderLess console cursorBlink cursorUnderline hold iconic insecure
		587	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		588	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		589	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		590	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		591	tripleclickwords utmpInhibit visualBell
426		592
427	=item $value = $term->resource ($name[, $newval])	593	=item $value = $term->resource ($name[, $newval])
428		594
429	Returns the current resource value associated with a given name and	595	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>	596	optionally sets a new value. Setting values is most useful in the C<init>
…		…
440		606
441	Please note that resource strings will currently only be freed when the	607	Please note that resource strings will currently only be freed when the
442	terminal is destroyed, so changing options frequently will eat memory.	608	terminal is destroyed, so changing options frequently will eat memory.
443		609
444	Here is a a likely non-exhaustive list of resource names, not all of which	610	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	611	are supported in every build, please see the source file F</src/rsinc.h>
446	list:	612	to see the actual list:
447		613
448	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	614	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
449	borderLess color cursorBlink cursorUnderline cutchars delete_key	615	borderLess color cursorBlink cursorUnderline cutchars delete_key
450	display_name embed ext_bwidth fade font geometry hold iconName	616	display_name embed ext_bwidth fade font geometry hold iconName
451	imFont imLocale inputMethod insecure int_bwidth intensityStyles	617	imFont imLocale inputMethod insecure int_bwidth intensityStyles
452	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	618	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
453	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	619	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
454	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	620	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
455	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	621	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
456	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	622	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
457	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	623	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
458	shade term_name title transparent transparent_all tripleclickwords	624	shade term_name title transparent transparent_all tripleclickwords
…		…
461	=cut	627	=cut
462		628
463	sub urxvt::term::resource($$;$) {	629	sub urxvt::term::resource($$;$) {
464	my ($self, $name) = (shift, shift);	630	my ($self, $name) = (shift, shift);
465	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	631	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
466	goto &urxvt::term::_resource;	632	&urxvt::term::_resource
467	}	633	}
		634
		635	=item $rend = $term->rstyle ([$new_rstyle])
		636
		637	Return and optionally change the current rendition. Text that is output by
		638	the terminal application will use this style.
		639
		640	=item ($row, $col) = $term->screen_cur ([$row, $col])
		641
		642	Return the current coordinates of the text cursor position and optionally
		643	set it (which is usually bad as applications don't expect that).
468		644
469	=item ($row, $col) = $term->selection_mark ([$row, $col])	645	=item ($row, $col) = $term->selection_mark ([$row, $col])
470		646
471	=item ($row, $col) = $term->selection_beg ([$row, $col])	647	=item ($row, $col) = $term->selection_beg ([$row, $col])
472		648
…		…
487	#=item $term->overlay ($x, $y, $text)	663	#=item $term->overlay ($x, $y, $text)
488	#	664	#
489	#Create a simple multi-line overlay box. See the next method for details.	665	#Create a simple multi-line overlay box. See the next method for details.
490	#	666	#
491	#=cut	667	#=cut
492		668	#
493	sub urxvt::term::scr_overlay {	669	#sub urxvt::term::scr_overlay {
494	die;
495	my ($self, $x, $y, $text) = @_;	670	# my ($self, $x, $y, $text) = @_;
496		671	#
497	my @lines = split /\n/, $text;	672	# my @lines = split /\n/, $text;
498		673	#
499	my $w = 0;	674	# my $w = 0;
500	for (map $self->strwidth ($_), @lines) {	675	# for (map $self->strwidth ($_), @lines) {
501	$w = $_ if $w < $_;	676	# $w = $_ if $w < $_;
502	}	677	# }
503		678	#
504	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	679	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
505	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	680	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
506	}	681	#}
507		682
508	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	683	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
509		684
510	Create a new (empty) overlay at the given position with the given	685	Create a new (empty) overlay at the given position with the given
511	width/height. C<$rstyle> defines the initial rendition style	686	width/height. C<$rstyle> defines the initial rendition style
…		…
538		713
539	If hidden, display the overlay again.	714	If hidden, display the overlay again.
540		715
541	=back	716	=back
542		717
		718	=item $popup = $term->popup ($event)
		719
		720	Creates a new C<urxvt::popup> object that implements a popup menu. The
		721	C<$event> I<must> be the event causing the menu to pop up (a button event,
		722	currently).
		723
		724	=cut
		725
		726	sub urxvt::term::popup {
		727	my ($self, $event) = @_;
		728
		729	$self->grab ($event->{time}, 1)
		730	or return;
		731
		732	my $popup = bless {
		733	term => $self,
		734	event => $event,
		735	}, urxvt::popup::;
		736
		737	Scalar::Util::weaken $popup->{term};
		738
		739	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		740	Scalar::Util::weaken $self->{_destroy}{$popup};
		741
		742	$popup
		743	}
		744
543	=item $cellwidth = $term->strwidth $string	745	=item $cellwidth = $term->strwidth ($string)
544		746
545	Returns the number of screen-cells this string would need. Correctly	747	Returns the number of screen-cells this string would need. Correctly
546	accounts for wide and combining characters.	748	accounts for wide and combining characters.
547		749
548	=item $octets = $term->locale_encode $string	750	=item $octets = $term->locale_encode ($string)
549		751
550	Convert the given text string into the corresponding locale encoding.	752	Convert the given text string into the corresponding locale encoding.
551		753
552	=item $string = $term->locale_decode $octets	754	=item $string = $term->locale_decode ($octets)
553		755
554	Convert the given locale-encoded octets into a perl string.	756	Convert the given locale-encoded octets into a perl string.
		757
		758	=item $term->scr_add_lines ($string)
		759
		760	Write the given text string to the screen, as if output by the application
		761	running inside the terminal. It may not contain command sequences (escape
		762	codes), but is free to use line feeds, carriage returns and tabs. The
		763	string is a normal text string, not in locale-dependent encoding.
		764
		765	Normally its not a good idea to use this function, as programs might be
		766	confused by changes in cursor position or scrolling. Its useful inside a
		767	C<on_add_lines> hook, though.
		768
		769	=item $term->cmd_parse ($octets)
		770
		771	Similar to C<scr_add_lines>, but the argument must be in the
		772	locale-specific encoding of the terminal and can contain command sequences
		773	(escape codes) that will be interpreted.
555		774
556	=item $term->tt_write ($octets)	775	=item $term->tt_write ($octets)
557		776
558	Write the octets given in C<$data> to the tty (i.e. as program input). To	777	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	778	pass characters instead of octets, you should convert your strings first
560	to the locale-specific encoding using C<< $term->locale_encode >>.	779	to the locale-specific encoding using C<< $term->locale_encode >>.
561		780
		781	=item $windowid = $term->parent
		782
		783	Return the window id of the toplevel window.
		784
		785	=item $windowid = $term->vt
		786
		787	Return the window id of the terminal window.
		788
		789	=item $window_width = $term->width
		790
		791	=item $window_height = $term->height
		792
		793	=item $font_width = $term->fwidth
		794
		795	=item $font_height = $term->fheight
		796
		797	=item $font_ascent = $term->fbase
		798
562	=item $nrow = $term->nrow	799	=item $terminal_rows = $term->nrow
563		800
564	=item $ncol = $term->ncol	801	=item $terminal_columns = $term->ncol
565		802
566	Return the number of rows/columns of the terminal window (i.e. as	803	=item $has_focus = $term->focus
567	specified by C<-geometry>, excluding any scrollback).
568		804
569	=item $nsaved = $term->nsaved	805	=item $is_mapped = $term->mapped
570		806
571	Returns the number of lines in the scrollback buffer.	807	=item $max_scrollback = $term->saveLines
		808
		809	=item $nrow_plus_saveLines = $term->total_rows
		810
		811	=item $lines_in_scrollback = $term->nsaved
		812
		813	Return various integers describing terminal characteristics.
		814
		815	=item $modifiermask = $term->ModLevel3Mask
		816
		817	=item $modifiermask = $term->ModMetaMask
		818
		819	=item $modifiermask = $term->ModNumLockMask
		820
		821	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		822	AltGr), the meta key (often Alt) and the num lock key, if applicable.
572		823
573	=item $view_start = $term->view_start ([$newvalue])	824	=item $view_start = $term->view_start ([$newvalue])
574		825
575	Returns the negative row number of the topmost line. Minimum value is	826	Returns the negative row number of the topmost line. Minimum value is
576	C<0>, which displays the normal terminal contents. Larger values scroll	827	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	890	about the logical line that row C<$row_number> is part of. It supports the
640	following methods:	891	following methods:
641		892
642	=over 4	893	=over 4
643		894
644	=item $text = $line->t	895	=item $text = $line->t ([$new_text])
645		896
646	Returns the full text of the line, similar to C<ROW_t>	897	Returns or replaces the full text of the line, similar to C<ROW_t>
647		898
648	=item $rend = $line->r	899	=item $rend = $line->r ([$new_rend])
649		900
650	Returns the full rendition array of the line, similar to C<ROW_r>	901	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
651		902
652	=item $length = $line->l	903	=item $length = $line->l
653		904
654	Returns the length of the line in cells, similar to C<ROW_l>.	905	Returns the length of the line in cells, similar to C<ROW_l>.
655		906
…		…
684		935
685	bless {	936	bless {
686	term => $self,	937	term => $self,
687	beg => $beg,	938	beg => $beg,
688	end => $end,	939	end => $end,
		940	ncol => $self->ncol,
689	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	941	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
690	}, urxvt::line::	942	}, urxvt::line::
691	}	943	}
692		944
693	sub urxvt::line::t {	945	sub urxvt::line::t {
694	my ($self) = @_;	946	my ($self) = @_;
695		947
		948	if (@_ > 1)
		949	{
		950	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		951	for $self->{beg} .. $self->{end};
		952	}
		953
		954	defined wantarray &&
696	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	955	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
697	0, $self->{len}	956	0, $self->{len}
698	}	957	}
699		958
700	sub urxvt::line::r {	959	sub urxvt::line::r {
701	my ($self) = @_;	960	my ($self) = @_;
702		961
		962	if (@_ > 1)
		963	{
		964	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		965	for $self->{beg} .. $self->{end};
		966	}
		967
		968	if (defined wantarray) {
703	my $rend = [	969	my $rend = [
704	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	970	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
705	];	971	];
706	$#$rend = $self->{len} - 1;	972	$#$rend = $self->{len} - 1;
707	$rend	973	return $rend;
		974	}
		975
		976	()
708	}	977	}
709		978
710	sub urxvt::line::beg { $_[0]{beg} }	979	sub urxvt::line::beg { $_[0]{beg} }
711	sub urxvt::line::end { $_[0]{end} }	980	sub urxvt::line::end { $_[0]{end} }
712	sub urxvt::line::l { $_[0]{len} }	981	sub urxvt::line::l { $_[0]{len} }
713		982
714	sub urxvt::line::offset_of {	983	sub urxvt::line::offset_of {
715	my ($self, $row, $col) = @_;	984	my ($self, $row, $col) = @_;
716		985
717	($row - $self->{beg}) * $self->{term}->ncol + $col	986	($row - $self->{beg}) * $self->{ncol} + $col
718	}	987	}
719		988
720	sub urxvt::line::coord_of {	989	sub urxvt::line::coord_of {
721	my ($self, $offset) = @_;	990	my ($self, $offset) = @_;
722		991
723	use integer;	992	use integer;
724		993
725	(	994	(
726	$offset / $self->{term}->ncol + $self->{beg},	995	$offset / $self->{ncol} + $self->{beg},
727	$offset % $self->{term}->ncol	996	$offset % $self->{ncol}
728	)	997	)
729	}	998	}
730		999
731	=item ($row, $col) = $line->coord_of ($offset)	1000	=item ($row, $col) = $line->coord_of ($offset)
732	=item $text = $term->special_encode $string	1001	=item $text = $term->special_encode $string
…		…
739		1008
740	Converts rxvt-unicodes text reprsentation into a perl string. See	1009	Converts rxvt-unicodes text reprsentation into a perl string. See
741	C<< $term->ROW_t >> for details.	1010	C<< $term->ROW_t >> for details.
742		1011
743	=back	1012	=back
		1013
		1014	=head2 The C<urxvt::popup> Class
		1015
		1016	=over 4
		1017
		1018	=cut
		1019
		1020	package urxvt::popup;
		1021
		1022	sub add_item {
		1023	my ($self, $item) = @_;
		1024
		1025	push @{ $self->{item} }, $item;
		1026	}
		1027
		1028	sub add_button {
		1029	my ($self, $text, $cb) = @_;
		1030
		1031	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,
		1032	render => sub { $_[0]{text} },
		1033	});
		1034	}
		1035
		1036	sub add_toggle {
		1037	my ($self, $text, $cb, $value) = @_;
		1038
		1039	my $item; $item = {
		1040	type => "button",
		1041	text => " $text",
		1042	value => $value,
		1043	render => sub { ($item->{value} ? "✔" : " ") . $text },
		1044	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1045	};
		1046
		1047	$self->add_item ($item);
		1048	}
		1049
		1050	sub show {
		1051	my ($self) = @_;
		1052
		1053	local $urxvt::popup::self = $self;
		1054
		1055	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1056	"--transient-for" => $self->{term}->parent,
		1057	"-pe" => "urxvt-popup")
		1058	or die "unable to create popup window\n";
		1059	}
		1060
		1061	sub DESTROY {
		1062	my ($self) = @_;
		1063
		1064	$self->{term}->ungrab;
		1065	}
744		1066
745	=head2 The C<urxvt::timer> Class	1067	=head2 The C<urxvt::timer> Class
746		1068
747	This class implements timer watchers/events. Time is represented as a	1069	This class implements timer watchers/events. Time is represented as a
748	fractional number of seconds since the epoch. Example:	1070	fractional number of seconds since the epoch. Example:
…		…
850	This variable controls the verbosity level of the perl extension. Higher	1172	This variable controls the verbosity level of the perl extension. Higher
851	numbers indicate more verbose output.	1173	numbers indicate more verbose output.
852		1174
853	=over 4	1175	=over 4
854		1176
855	=item 0 - only fatal messages	1177	=item =0 - only fatal messages
856		1178
857	=item 3 - script loading and management	1179	=item =3 - script loading and management
858		1180
859	=item 10 - all events received	1181	=item =10 - all events received
860		1182
861	=back	1183	=back
862		1184
863	=head1 AUTHOR	1185	=head1 AUTHOR
864		1186

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.26 by root, Tue Jan 3 21:22:22 2006 UTC vs. Revision 1.49 by root, Sun Jan 8 00:07:18 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.26 by root, Tue Jan 3 21:22:22 2006 UTC vs.
Revision 1.49 by root, Sun Jan 8 00:07:18 2006 UTC