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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.48 by root, Sat Jan 7 21:43:17 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
…		…
141	click) and is either supposed to return false (normal operation), or	178	click) and is either supposed to return false (normal operation), or
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
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		183
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
…		…
185		212
186	Be careful not ever to trust (in a security sense) the data you receive,	213	Be careful not ever to trust (in a security sense) the data you receive,
187	as its source can not easily be controleld (e-mail content, messages from	214	as its source can not easily be controleld (e-mail content, messages from
188	other users on the same system etc.).	215	other users on the same system etc.).
189		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.
		238
190	=item on_refresh_begin $term	239	=item on_refresh_begin $term
191		240
192	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
193	or similar effects by modify terminal contents in refresh_begin, and	242	or similar effects by modify terminal contents in refresh_begin, and
194	restoring them in refresh_end. The built-in overlay and selection display	243	restoring them in refresh_end. The built-in overlay and selection display
…		…
202		251
203	Called whenever the user presses a key combination that has a	252	Called whenever the user presses a key combination that has a
204	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>
205	resource in the @@RXVT_NAME@@(1) manpage).	254	resource in the @@RXVT_NAME@@(1) manpage).
206		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
207	=back	292	=back
208		293
209	=head2 Variables in the C<urxvt> Package	294	=head2 Variables in the C<urxvt> Package
210		295
211	=over 4	296	=over 4
212		297
213	=item $urxvt::TERM	298	=item $urxvt::TERM
214		299
215	The current terminal. Whenever a callback/Hook is bein executed, this	300	The current terminal. This variable stores the current C<urxvt::term>
216	variable stores the current C<urxvt::term> object.	301	object, whenever a callback/hook is executing.
217		302
218	=back	303	=back
219		304
220	=head2 Functions in the C<urxvt> Package	305	=head2 Functions in the C<urxvt> Package
221		306
222	=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.
223		316
224	=item urxvt::fatal $errormessage	317	=item urxvt::fatal $errormessage
225		318
226	Fatally aborts execution with the given error message. Avoid at all	319	Fatally aborts execution with the given error message. Avoid at all
227	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
…		…
237	correct place, e.g. on stderr of the connecting urxvtc client.	330	correct place, e.g. on stderr of the connecting urxvtc client.
238		331
239	=item $time = urxvt::NOW	332	=item $time = urxvt::NOW
240		333
241	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.
242		343
243	=back	344	=back
244		345
245	=head2 RENDITION	346	=head2 RENDITION
246		347
…		…
296		397
297	=cut	398	=cut
298		399
299	package urxvt;	400	package urxvt;
300		401
		402	use utf8;
301	use strict;	403	use strict;
302	use Scalar::Util ();	404	use Scalar::Util ();
		405	use List::Util ();
303		406
304	our $TERM;	407	our $TERM;
305	our @HOOKNAME;	408	our @HOOKNAME;
306	our $LIBDIR;	409	our $LIBDIR;
307		410
…		…
340	$hook_count[$htype]++	443	$hook_count[$htype]++
341	or set_should_invoke $htype, 1;	444	or set_should_invoke $htype, 1;
342	}	445	}
343	}	446	}
344		447
345	my $script_pkg = "script0000";	448	my $extension_pkg = "extension0000";
346	my %script_pkg;	449	my %extension_pkg;
347		450
348	# load a single script into its own package, once only	451	# load a single script into its own package, once only
349	sub script_package($) {	452	sub extension_package($) {
350	my ($path) = @_;	453	my ($path) = @_;
351		454
352	$script_pkg{$path} \|\|= do {	455	$extension_pkg{$path} \|\|= do {
353	my $pkg = "urxvt::" . ($script_pkg++);	456	my $pkg = "urxvt::" . ($extension_pkg++);
354		457
355	verbose 3, "loading script '$path' into package '$pkg'";	458	verbose 3, "loading extension '$path' into package '$pkg'";
356		459
357	open my $fh, "<:raw", $path	460	open my $fh, "<:raw", $path
358	or die "$path: $!";	461	or die "$path: $!";
359		462
360	my $source = "package $pkg; use strict; use utf8;\n"	463	my $source = "package $pkg; use strict; use utf8;\n"
		464	. "use base urxvt::term::proxy::;\n"
361	. "#line 1 \"$path\"\n{\n"	465	. "#line 1 \"$path\"\n{\n"
362	. (do { local $/; <$fh> })	466	. (do { local $/; <$fh> })
363	. "\n};\n1";	467	. "\n};\n1";
364		468
365	eval $source or die "$path: $@";	469	eval $source or die "$path: $@";
…		…
376	my $htype = shift;	480	my $htype = shift;
377		481
378	if ($htype == 0) { # INIT	482	if ($htype == 0) { # INIT
379	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	483	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
380		484
381	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	485	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
382	my @files = grep -f $_, map "$_/$ext", @dirs;	486	my @files = grep -f $_, map "$_/$ext", @dirs;
383		487
384	if (@files) {	488	if (@files) {
385	register_package script_package $files[0];	489	register_package extension_package $files[0];
386	} else {	490	} else {
387	warn "perl extension '$ext' not found in perl library search path\n";	491	warn "perl extension '$ext' not found in perl library search path\n";
388	}	492	}
389	}	493	}
390	}	494	}
…		…
396	if $verbosity >= 10;	500	if $verbosity >= 10;
397		501
398	keys %$cb;	502	keys %$cb;
399		503
400	while (my ($pkg, $cb) = each %$cb) {	504	while (my ($pkg, $cb) = each %$cb) {
		505	eval {
401	$retval = $cb->(	506	$retval = $cb->(
402	$TERM->{_pkg}{$pkg} \|\|= do {	507	$TERM->{_pkg}{$pkg} \|\|= do {
403	my $proxy = bless { }, urxvt::term::proxy::;	508	my $proxy = bless { }, $pkg;
404	Scalar::Util::weaken ($proxy->{term} = $TERM);	509	Scalar::Util::weaken ($proxy->{term} = $TERM);
405	$proxy	510	$proxy
406	},	511	},
407	@_,	512	@_,
408	) and last;	513	) and last;
		514	};
		515	warn $@ if $@;#d#
409	}	516	}
410	}	517	}
411		518
412	if ($htype == 1) { # DESTROY	519	if ($htype == 1) { # DESTROY
413	# remove hooks if unused	520	# remove hooks if unused
…		…
441	} or die "FATAL: unable to compile method forwarder: $@";	548	} or die "FATAL: unable to compile method forwarder: $@";
442		549
443	goto &$urxvt::term::proxy::AUTOLOAD;	550	goto &$urxvt::term::proxy::AUTOLOAD;
444	}	551	}
445		552
		553	sub urxvt::destroy_hook::DESTROY {
		554	${$_[0]}->();
		555	}
		556
		557	sub urxvt::destroy_hook(&) {
		558	bless \shift, urxvt::destroy_hook::
		559	}
		560
446	=head2 The C<urxvt::term> Class	561	=head2 The C<urxvt::term> Class
447		562
448	=over 4	563	=over 4
		564
		565	=item $term->destroy
		566
		567	Destroy the terminal object (close the window, free resources etc.).
449		568
450	=item $value = $term->resource ($name[, $newval])	569	=item $value = $term->resource ($name[, $newval])
451		570
452	Returns the current resource value associated with a given name and	571	Returns the current resource value associated with a given name and
453	optionally sets a new value. Setting values is most useful in the C<init>	572	optionally sets a new value. Setting values is most useful in the C<init>
…		…
484	=cut	603	=cut
485		604
486	sub urxvt::term::resource($$;$) {	605	sub urxvt::term::resource($$;$) {
487	my ($self, $name) = (shift, shift);	606	my ($self, $name) = (shift, shift);
488	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	607	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
489	goto &urxvt::term::_resource;	608	&urxvt::term::_resource
490	}	609	}
491		610
492	=item $rend = $term->screen_rstyle ([$new_rstyle])	611	=item $rend = $term->rstyle ([$new_rstyle])
493		612
494	Return and optionally change the current rendition. Text thta is output by	613	Return and optionally change the current rendition. Text that is output by
495	the temrianl application will use this style.	614	the terminal application will use this style.
496		615
497	=item ($row, $col) = $term->screen_cur ([$row, $col])	616	=item ($row, $col) = $term->screen_cur ([$row, $col])
498		617
499	Return the current coordinates of the text cursor position and optionally	618	Return the current coordinates of the text cursor position and optionally
500	set it (which is usually bad as applications don't expect that).	619	set it (which is usually bad as applications don't expect that).
…		…
520	#=item $term->overlay ($x, $y, $text)	639	#=item $term->overlay ($x, $y, $text)
521	#	640	#
522	#Create a simple multi-line overlay box. See the next method for details.	641	#Create a simple multi-line overlay box. See the next method for details.
523	#	642	#
524	#=cut	643	#=cut
525		644	#
526	sub urxvt::term::scr_overlay {	645	#sub urxvt::term::scr_overlay {
527	die;
528	my ($self, $x, $y, $text) = @_;	646	# my ($self, $x, $y, $text) = @_;
529		647	#
530	my @lines = split /\n/, $text;	648	# my @lines = split /\n/, $text;
531		649	#
532	my $w = 0;	650	# my $w = 0;
533	for (map $self->strwidth ($_), @lines) {	651	# for (map $self->strwidth ($_), @lines) {
534	$w = $_ if $w < $_;	652	# $w = $_ if $w < $_;
535	}	653	# }
536		654	#
537	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	655	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
538	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	656	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
539	}	657	#}
540		658
541	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	659	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
542		660
543	Create a new (empty) overlay at the given position with the given	661	Create a new (empty) overlay at the given position with the given
544	width/height. C<$rstyle> defines the initial rendition style	662	width/height. C<$rstyle> defines the initial rendition style
…		…
571		689
572	If hidden, display the overlay again.	690	If hidden, display the overlay again.
573		691
574	=back	692	=back
575		693
		694	=item $popup = $term->popup ($event)
		695
		696	Creates a new C<urxvt::popup> object that implements a popup menu. The
		697	C<$event> I<must> be the event causing the menu to pop up (a button event,
		698	currently).
		699
		700	=cut
		701
		702	sub urxvt::term::popup {
		703	my ($self, $event) = @_;
		704
		705	$self->grab ($event->{time}, 1)
		706	or return;
		707
		708	my $popup = bless {
		709	term => $self,
		710	event => $event,
		711	}, urxvt::popup::;
		712
		713	Scalar::Util::weaken $popup->{term};
		714
		715	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		716	Scalar::Util::weaken $self->{_destroy}{$popup};
		717
		718	$popup
		719	}
		720
576	=item $cellwidth = $term->strwidth $string	721	=item $cellwidth = $term->strwidth ($string)
577		722
578	Returns the number of screen-cells this string would need. Correctly	723	Returns the number of screen-cells this string would need. Correctly
579	accounts for wide and combining characters.	724	accounts for wide and combining characters.
580		725
581	=item $octets = $term->locale_encode $string	726	=item $octets = $term->locale_encode ($string)
582		727
583	Convert the given text string into the corresponding locale encoding.	728	Convert the given text string into the corresponding locale encoding.
584		729
585	=item $string = $term->locale_decode $octets	730	=item $string = $term->locale_decode ($octets)
586		731
587	Convert the given locale-encoded octets into a perl string.	732	Convert the given locale-encoded octets into a perl string.
		733
		734	=item $term->scr_add_lines ($string)
		735
		736	Write the given text string to the screen, as if output by the application
		737	running inside the terminal. It may not contain command sequences (escape
		738	codes), but is free to use line feeds, carriage returns and tabs. The
		739	string is a normal text string, not in locale-dependent encoding.
		740
		741	Normally its not a good idea to use this function, as programs might be
		742	confused by changes in cursor position or scrolling. Its useful inside a
		743	C<on_add_lines> hook, though.
		744
		745	=item $term->cmd_parse ($octets)
		746
		747	Similar to C<scr_add_lines>, but the argument must be in the
		748	locale-specific encoding of the terminal and can contain command sequences
		749	(escape codes) that will be interpreted.
588		750
589	=item $term->tt_write ($octets)	751	=item $term->tt_write ($octets)
590		752
591	Write the octets given in C<$data> to the tty (i.e. as program input). To	753	Write the octets given in C<$data> to the tty (i.e. as program input). To
592	pass characters instead of octets, you should convert your strings first	754	pass characters instead of octets, you should convert your strings first
593	to the locale-specific encoding using C<< $term->locale_encode >>.	755	to the locale-specific encoding using C<< $term->locale_encode >>.
594		756
		757	=item $windowid = $term->parent
		758
		759	Return the window id of the toplevel window.
		760
		761	=item $windowid = $term->vt
		762
		763	Return the window id of the terminal window.
		764
595	=item $window_width = $term->width	765	=item $window_width = $term->width
596		766
597	=item $window_height = $term->height	767	=item $window_height = $term->height
598		768
599	=item $font_width = $term->fwidth	769	=item $font_width = $term->fwidth
…		…
615	=item $nrow_plus_saveLines = $term->total_rows	785	=item $nrow_plus_saveLines = $term->total_rows
616		786
617	=item $lines_in_scrollback = $term->nsaved	787	=item $lines_in_scrollback = $term->nsaved
618		788
619	Return various integers describing terminal characteristics.	789	Return various integers describing terminal characteristics.
		790
		791	=item $modifiermask = $term->ModLevel3Mask
		792
		793	=item $modifiermask = $term->ModMetaMask
		794
		795	=item $modifiermask = $term->ModNumLockMask
		796
		797	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		798	AltGr), the meta key (often Alt) and the num lock key, if applicable.
620		799
621	=item $view_start = $term->view_start ([$newvalue])	800	=item $view_start = $term->view_start ([$newvalue])
622		801
623	Returns the negative row number of the topmost line. Minimum value is	802	Returns the negative row number of the topmost line. Minimum value is
624	C<0>, which displays the normal terminal contents. Larger values scroll	803	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
687	about the logical line that row C<$row_number> is part of. It supports the	866	about the logical line that row C<$row_number> is part of. It supports the
688	following methods:	867	following methods:
689		868
690	=over 4	869	=over 4
691		870
692	=item $text = $line->t	871	=item $text = $line->t ([$new_text])
693		872
694	Returns the full text of the line, similar to C<ROW_t>	873	Returns or replaces the full text of the line, similar to C<ROW_t>
695		874
696	=item $rend = $line->r	875	=item $rend = $line->r ([$new_rend])
697		876
698	Returns the full rendition array of the line, similar to C<ROW_r>	877	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
699		878
700	=item $length = $line->l	879	=item $length = $line->l
701		880
702	Returns the length of the line in cells, similar to C<ROW_l>.	881	Returns the length of the line in cells, similar to C<ROW_l>.
703		882
…		…
732		911
733	bless {	912	bless {
734	term => $self,	913	term => $self,
735	beg => $beg,	914	beg => $beg,
736	end => $end,	915	end => $end,
		916	ncol => $self->ncol,
737	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	917	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
738	}, urxvt::line::	918	}, urxvt::line::
739	}	919	}
740		920
741	sub urxvt::line::t {	921	sub urxvt::line::t {
742	my ($self) = @_;	922	my ($self) = @_;
743		923
		924	if (@_ > 1)
		925	{
		926	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		927	for $self->{beg} .. $self->{end};
		928	}
		929
		930	defined wantarray &&
744	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	931	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
745	0, $self->{len}	932	0, $self->{len}
746	}	933	}
747		934
748	sub urxvt::line::r {	935	sub urxvt::line::r {
749	my ($self) = @_;	936	my ($self) = @_;
750		937
		938	if (@_ > 1)
		939	{
		940	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		941	for $self->{beg} .. $self->{end};
		942	}
		943
		944	if (defined wantarray) {
751	my $rend = [	945	my $rend = [
752	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	946	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
753	];	947	];
754	$#$rend = $self->{len} - 1;	948	$#$rend = $self->{len} - 1;
755	$rend	949	return $rend;
		950	}
		951
		952	()
756	}	953	}
757		954
758	sub urxvt::line::beg { $_[0]{beg} }	955	sub urxvt::line::beg { $_[0]{beg} }
759	sub urxvt::line::end { $_[0]{end} }	956	sub urxvt::line::end { $_[0]{end} }
760	sub urxvt::line::l { $_[0]{len} }	957	sub urxvt::line::l { $_[0]{len} }
761		958
762	sub urxvt::line::offset_of {	959	sub urxvt::line::offset_of {
763	my ($self, $row, $col) = @_;	960	my ($self, $row, $col) = @_;
764		961
765	($row - $self->{beg}) * $self->{term}->ncol + $col	962	($row - $self->{beg}) * $self->{ncol} + $col
766	}	963	}
767		964
768	sub urxvt::line::coord_of {	965	sub urxvt::line::coord_of {
769	my ($self, $offset) = @_;	966	my ($self, $offset) = @_;
770		967
771	use integer;	968	use integer;
772		969
773	(	970	(
774	$offset / $self->{term}->ncol + $self->{beg},	971	$offset / $self->{ncol} + $self->{beg},
775	$offset % $self->{term}->ncol	972	$offset % $self->{ncol}
776	)	973	)
777	}	974	}
778		975
779	=item ($row, $col) = $line->coord_of ($offset)	976	=item ($row, $col) = $line->coord_of ($offset)
780	=item $text = $term->special_encode $string	977	=item $text = $term->special_encode $string
…		…
787		984
788	Converts rxvt-unicodes text reprsentation into a perl string. See	985	Converts rxvt-unicodes text reprsentation into a perl string. See
789	C<< $term->ROW_t >> for details.	986	C<< $term->ROW_t >> for details.
790		987
791	=back	988	=back
		989
		990	=head2 The C<urxvt::popup> Class
		991
		992	=over 4
		993
		994	=cut
		995
		996	package urxvt::popup;
		997
		998	sub add_item {
		999	my ($self, $item) = @_;
		1000
		1001	push @{ $self->{item} }, $item;
		1002	}
		1003
		1004	sub add_button {
		1005	my ($self, $text, $cb) = @_;
		1006
		1007	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,
		1008	render => sub { $_[0]{text} },
		1009	});
		1010	}
		1011
		1012	sub add_toggle {
		1013	my ($self, $text, $cb, $value) = @_;
		1014
		1015	$self->add_item ({ type => "button", text => " $text", value => $value,
		1016	render => sub { ($_[0]{value} ? "✔" : " ") . substr $_[0]{text}, 1 },
		1017	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1018	});
		1019	}
		1020
		1021	sub show {
		1022	my ($self) = @_;
		1023
		1024	local $urxvt::popup::self = $self;
		1025
		1026	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1027	"--transient-for" => $self->{term}->parent,
		1028	"-pe" => "urxvt-popup")
		1029	or die "unable to create popup window\n";
		1030	}
		1031
		1032	sub DESTROY {
		1033	my ($self) = @_;
		1034
		1035	$self->{term}->ungrab;
		1036	}
792		1037
793	=head2 The C<urxvt::timer> Class	1038	=head2 The C<urxvt::timer> Class
794		1039
795	This class implements timer watchers/events. Time is represented as a	1040	This class implements timer watchers/events. Time is represented as a
796	fractional number of seconds since the epoch. Example:	1041	fractional number of seconds since the epoch. Example:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC vs. Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC