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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.22 by root, Tue Jan 3 19:10:54 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
…		…
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection
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
…		…
57	=back	59	=back
58		60
59	=item digital-clock	61	=item digital-clock
60		62
61	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.
62		74
63	=item example-refresh-hooks	75	=item example-refresh-hooks
64		76
65	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
66	window. Illustrates overwriting the refresh callbacks to create your own	78	window. Illustrates overwriting the refresh callbacks to create your own
…		…
71	=head2 General API Considerations	83	=head2 General API Considerations
72		84
73	All objects (such as terminals, time watchers etc.) are typical	85	All objects (such as terminals, time watchers etc.) are typical
74	reference-to-hash objects. The hash can be used to store anything you	86	reference-to-hash objects. The hash can be used to store anything you
75	like. All members starting with an underscore (such as C<_ptr> or	87	like. All members starting with an underscore (such as C<_ptr> or
76	C<_hook>) are reserved for internal uses and must not be accessed or	88	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
77	modified).	89	modified).
78		90
79	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
80	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
81	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
82	terminal is destroyed.	94	terminal is destroyed.
83		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
84	=head2 Hooks	119	=head2 Hooks
85		120
86	The following subroutines can be declared in loaded scripts, and will be called	121	The following subroutines can be declared in extension files, and will be
87	whenever the relevant event happens.	122	called whenever the relevant event happens.
		123
		124	The first argument passed to them is an object private to each terminal
		125	and extension package. You can call all C<urxvt::term> methods on it, but
		126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		127	object that is shared between all packages is stored in the C<term>
		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.
88		130
89	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
90	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,
91	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.
92		134
…		…
95	=over 4	137	=over 4
96		138
97	=item on_init $term	139	=item on_init $term
98		140
99	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
100	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.
101		146
102	=item on_reset $term	147	=item on_reset $term
103		148
104	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
105	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
…		…
134	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
135	processing.	180	processing.
136		181
137	See the F<selection> example extension.	182	See the F<selection> example extension.
138		183
139	=item on_focus_in $term
140
141	Called whenever the window gets the keyboard focus, before urxvt does
142	focus in processing.
143
144	=item on_focus_out $term
145
146	Called wheneever the window loses keyboard focus, before urxvt does focus
147	out processing.
148
149	=item on_view_change $term, $offset	184	=item on_view_change $term, $offset
150		185
151	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
152	scrolls. Offset C<0> means display the normal terminal, positive values	187	scrolls. Offset C<0> means display the normal terminal, positive values
153	show this many lines of scrollback.	188	show this many lines of scrollback.
…		…
163	number of lines that will be in the scrollback buffer.	198	number of lines that will be in the scrollback buffer.
164		199
165	=item on_tty_activity $term NYI	200	=item on_tty_activity $term NYI
166		201
167	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.
168		238
169	=item on_refresh_begin $term	239	=item on_refresh_begin $term
170		240
171	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
172	or similar effects by modify terminal contents in refresh_begin, and	242	or similar effects by modify terminal contents in refresh_begin, and
…		…
181		251
182	Called whenever the user presses a key combination that has a	252	Called whenever the user presses a key combination that has a
183	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>
184	resource in the @@RXVT_NAME@@(1) manpage).	254	resource in the @@RXVT_NAME@@(1) manpage).
185		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
		292	=back
		293
		294	=head2 Variables in the C<urxvt> Package
		295
		296	=over 4
		297
		298	=item $urxvt::TERM
		299
		300	The current terminal. This variable stores the current C<urxvt::term>
		301	object, whenever a callback/hook is executing.
		302
186	=back	303	=back
187		304
188	=head2 Functions in the C<urxvt> Package	305	=head2 Functions in the C<urxvt> Package
189		306
190	=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.
191		316
192	=item urxvt::fatal $errormessage	317	=item urxvt::fatal $errormessage
193		318
194	Fatally aborts execution with the given error message. Avoid at all	319	Fatally aborts execution with the given error message. Avoid at all
195	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
…		…
205	correct place, e.g. on stderr of the connecting urxvtc client.	330	correct place, e.g. on stderr of the connecting urxvtc client.
206		331
207	=item $time = urxvt::NOW	332	=item $time = urxvt::NOW
208		333
209	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.
210		343
211	=back	344	=back
212		345
213	=head2 RENDITION	346	=head2 RENDITION
214		347
…		…
264		397
265	=cut	398	=cut
266		399
267	package urxvt;	400	package urxvt;
268		401
		402	use utf8;
269	use strict;	403	use strict;
		404	use Scalar::Util ();
		405	use List::Util ();
270		406
271	our $term;	407	our $TERM;
272	our @HOOKNAME;	408	our @HOOKNAME;
		409	our %OPTION;
273	our $LIBDIR;	410	our $LIBDIR;
274		411
275	BEGIN {	412	BEGIN {
276	urxvt->bootstrap;	413	urxvt->bootstrap;
277		414
…		…
301	my $name = $HOOKNAME[$htype];	438	my $name = $HOOKNAME[$htype];
302		439
303	my $ref = $pkg->can ("on_" . lc $name)	440	my $ref = $pkg->can ("on_" . lc $name)
304	or next;	441	or next;
305		442
306	$term->{_hook}[$htype]{$ref*1} = $ref;	443	$TERM->{_hook}[$htype]{$pkg} = $ref;
307	$hook_count[$htype]++	444	$hook_count[$htype]++
308	or set_should_invoke $htype, 1;	445	or set_should_invoke $htype, 1;
309	}	446	}
310	}	447	}
311		448
312	my $script_pkg = "script0000";	449	my $extension_pkg = "extension0000";
313	my %script_pkg;	450	my %extension_pkg;
314		451
315	# load a single script into its own package, once only	452	# load a single script into its own package, once only
316	sub script_package($) {	453	sub extension_package($) {
317	my ($path) = @_;	454	my ($path) = @_;
318		455
319	$script_pkg{$path} \|\|= do {	456	$extension_pkg{$path} \|\|= do {
320	my $pkg = "urxvt::" . ($script_pkg++);	457	my $pkg = "urxvt::" . ($extension_pkg++);
321		458
322	verbose 3, "loading script '$path' into package '$pkg'";	459	verbose 3, "loading extension '$path' into package '$pkg'";
323		460
324	open my $fh, "<:raw", $path	461	open my $fh, "<:raw", $path
325	or die "$path: $!";	462	or die "$path: $!";
326		463
327	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"
328	. "#line 1 \"$path\"\n{\n"	466	. "#line 1 \"$path\"\n{\n"
329	. (do { local $/; <$fh> })	467	. (do { local $/; <$fh> })
330	. "\n};\n1";	468	. "\n};\n1";
331		469
332	eval $source or die "$path: $@";	470	eval $source or die "$path: $@";
333		471
334	$pkg	472	$pkg
335	}	473	}
336	}	474	}
337		475
		476	our $retval; # return value for urxvt
		477
338	# called by the rxvt core	478	# called by the rxvt core
339	sub invoke {	479	sub invoke {
340	local $term = shift;	480	local $TERM = shift;
341	my $htype = shift;	481	my $htype = shift;
342		482
343	if ($htype == 0) { # INIT	483	if ($htype == 0) { # INIT
344	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	484	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		485
		486	my @ext = (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2);
345		487
346	for my $ext (split /:/, $term->resource ("perl_ext")) {	488	while (@ext) {
347	my @files = grep -f $_, map "$_/$ext", @dirs;	489	my $ext = shift @ext;
348		490	if ($ext eq "default") {
349	if (@files) {	491	unshift @ext, qw(selection);
350	register_package script_package $files[0];
351	} else {	492	} else {
		493	my @files = grep -f $_, map "$_/$ext", @dirs;
		494
		495	if (@files) {
		496	register_package extension_package $files[0];
		497	} else {
352	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	}
353	}	500	}
354	}	501	}
		502	}
355		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
356	} elsif ($htype == 1) { # DESTROY	527	if ($htype == 1) { # DESTROY
		528	# remove hooks if unused
357	if (my $hook = $term->{_hook}) {	529	if (my $hook = $TERM->{_hook}) {
358	for my $htype (0..$#$hook) {	530	for my $htype (0..$#$hook) {
359	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	531	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
360	or set_should_invoke $htype, 0;	532	or set_should_invoke $htype, 0;
361	}	533	}
362	}	534	}
		535
		536	# clear package objects
		537	%$_ = () for values %{ $TERM->{_pkg} };
		538
		539	# clear package
		540	%$TERM = ();
363	}	541	}
364		542
365	my $cb = $term->{_hook}[$htype]	543	$retval
366	or return;	544	}
367		545
368	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	546	sub urxvt::term::proxy::AUTOLOAD {
369	if $verbosity >= 10;	547	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		548	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
370		549
371	while (my ($k, $v) = each %$cb) {	550	eval qq{
372	return 1 if $v->($term, @_);	551	sub $urxvt::term::proxy::AUTOLOAD {
373	}	552	my \$proxy = shift;
		553	\$proxy->{term}->$1 (\@_)
		554	}
		555	1
		556	} or die "FATAL: unable to compile method forwarder: $@";
374		557
375	0	558	goto &$urxvt::term::proxy::AUTOLOAD;
		559	}
		560
		561	sub urxvt::destroy_hook::DESTROY {
		562	${$_[0]}->();
		563	}
		564
		565	sub urxvt::destroy_hook(&) {
		566	bless \shift, urxvt::destroy_hook::
376	}	567	}
377		568
378	=head2 The C<urxvt::term> Class	569	=head2 The C<urxvt::term> Class
379		570
380	=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
381		592
382	=item $value = $term->resource ($name[, $newval])	593	=item $value = $term->resource ($name[, $newval])
383		594
384	Returns the current resource value associated with a given name and	595	Returns the current resource value associated with a given name and
385	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>
…		…
395		606
396	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
397	terminal is destroyed, so changing options frequently will eat memory.	608	terminal is destroyed, so changing options frequently will eat memory.
398		609
399	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
400	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>
401	list:	612	to see the actual list:
402		613
403	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	614	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
404	borderLess color cursorBlink cursorUnderline cutchars delete_key	615	borderLess color cursorBlink cursorUnderline cutchars delete_key
405	display_name embed ext_bwidth fade font geometry hold iconName	616	display_name embed ext_bwidth fade font geometry hold iconName
406	imFont imLocale inputMethod insecure int_bwidth intensityStyles	617	imFont imLocale inputMethod insecure int_bwidth intensityStyles
407	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	618	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
408	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	619	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
409	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	620	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
410	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	621	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
411	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	622	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
412	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	623	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
413	shade term_name title transparent transparent_all tripleclickwords	624	shade term_name title transparent transparent_all tripleclickwords
…		…
416	=cut	627	=cut
417		628
418	sub urxvt::term::resource($$;$) {	629	sub urxvt::term::resource($$;$) {
419	my ($self, $name) = (shift, shift);	630	my ($self, $name) = (shift, shift);
420	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	631	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
421	goto &urxvt::term::_resource;	632	&urxvt::term::_resource
422	}	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).
423		644
424	=item ($row, $col) = $term->selection_mark ([$row, $col])	645	=item ($row, $col) = $term->selection_mark ([$row, $col])
425		646
426	=item ($row, $col) = $term->selection_beg ([$row, $col])	647	=item ($row, $col) = $term->selection_beg ([$row, $col])
427		648
…		…
442	#=item $term->overlay ($x, $y, $text)	663	#=item $term->overlay ($x, $y, $text)
443	#	664	#
444	#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.
445	#	666	#
446	#=cut	667	#=cut
447		668	#
448	sub urxvt::term::scr_overlay {	669	#sub urxvt::term::scr_overlay {
449	die;
450	my ($self, $x, $y, $text) = @_;	670	# my ($self, $x, $y, $text) = @_;
451		671	#
452	my @lines = split /\n/, $text;	672	# my @lines = split /\n/, $text;
453		673	#
454	my $w = 0;	674	# my $w = 0;
455	for (map $self->strwidth ($_), @lines) {	675	# for (map $self->strwidth ($_), @lines) {
456	$w = $_ if $w < $_;	676	# $w = $_ if $w < $_;
457	}	677	# }
458		678	#
459	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	679	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
460	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	680	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
461	}	681	#}
462		682
463	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	683	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
464		684
465	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
466	width/height. C<$rstyle> defines the initial rendition style	686	width/height. C<$rstyle> defines the initial rendition style
…		…
493		713
494	If hidden, display the overlay again.	714	If hidden, display the overlay again.
495		715
496	=back	716	=back
497		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
498	=item $cellwidth = $term->strwidth $string	745	=item $cellwidth = $term->strwidth ($string)
499		746
500	Returns the number of screen-cells this string would need. Correctly	747	Returns the number of screen-cells this string would need. Correctly
501	accounts for wide and combining characters.	748	accounts for wide and combining characters.
502		749
503	=item $octets = $term->locale_encode $string	750	=item $octets = $term->locale_encode ($string)
504		751
505	Convert the given text string into the corresponding locale encoding.	752	Convert the given text string into the corresponding locale encoding.
506		753
507	=item $string = $term->locale_decode $octets	754	=item $string = $term->locale_decode ($octets)
508		755
509	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.
510		774
511	=item $term->tt_write ($octets)	775	=item $term->tt_write ($octets)
512		776
513	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
514	pass characters instead of octets, you should convert your strings first	778	pass characters instead of octets, you should convert your strings first
515	to the locale-specific encoding using C<< $term->locale_encode >>.	779	to the locale-specific encoding using C<< $term->locale_encode >>.
516		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
517	=item $nrow = $term->nrow	799	=item $terminal_rows = $term->nrow
518		800
519	=item $ncol = $term->ncol	801	=item $terminal_columns = $term->ncol
520		802
521	Return the number of rows/columns of the terminal window (i.e. as	803	=item $has_focus = $term->focus
522	specified by C<-geometry>, excluding any scrollback).
523		804
524	=item $nsaved = $term->nsaved	805	=item $is_mapped = $term->mapped
525		806
526	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.
527		823
528	=item $view_start = $term->view_start ([$newvalue])	824	=item $view_start = $term->view_start ([$newvalue])
529		825
530	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
531	C<0>, which displays the normal terminal contents. Larger values scroll	827	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
542	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	838	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
543		839
544	Returns the text of the entire row with number C<$row_number>. Row C<0>	840	Returns the text of the entire row with number C<$row_number>. Row C<0>
545	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	841	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
546	terminal line. The scrollback buffer starts at line C<-1> and extends to	842	terminal line. The scrollback buffer starts at line C<-1> and extends to
547	line C<< -$term->nsaved >>.	843	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		844	is requested.
548		845
549	If C<$new_text> is specified, it will replace characters in the current	846	If C<$new_text> is specified, it will replace characters in the current
550	line, starting at column C<$start_col> (default C<0>), which is useful	847	line, starting at column C<$start_col> (default C<0>), which is useful
551	to replace only parts of a line. The font index in the rendition will	848	to replace only parts of a line. The font index in the rendition will
552	automatically be updated.	849	automatically be updated.
…		…
574		871
575	See the section on RENDITION, above.	872	See the section on RENDITION, above.
576		873
577	=item $length = $term->ROW_l ($row_number[, $new_length])	874	=item $length = $term->ROW_l ($row_number[, $new_length])
578		875
579	Returns the number of screen cells that are in use ("the line length"). If	876	Returns the number of screen cells that are in use ("the line
580	it is C<-1>, then the line is part of a multiple-row logical "line", which	877	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
581	means all characters are in use and it is continued on the next row.	878	line is joined with the following one.
582		879
		880	=item $bool = $term->is_longer ($row_number)
		881
		882	Returns true if the row is part of a multiple-row logical "line" (i.e.
		883	joined with the following row), which means all characters are in use
		884	and it is continued on the next row (and possibly a continuation of the
		885	previous row(s)).
		886
		887	=item $line = $term->line ($row_number)
		888
		889	Create and return a new C<urxvt::line> object that stores information
		890	about the logical line that row C<$row_number> is part of. It supports the
		891	following methods:
		892
		893	=over 4
		894
		895	=item $text = $line->t ([$new_text])
		896
		897	Returns or replaces the full text of the line, similar to C<ROW_t>
		898
		899	=item $rend = $line->r ([$new_rend])
		900
		901	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		902
		903	=item $length = $line->l
		904
		905	Returns the length of the line in cells, similar to C<ROW_l>.
		906
		907	=item $rownum = $line->beg
		908
		909	=item $rownum = $line->end
		910
		911	Return the row number of the first/last row of the line, respectively.
		912
		913	=item $offset = $line->offset_of ($row, $col)
		914
		915	Returns the character offset of the given row\|col pair within the logical
		916	line.
		917
		918	=item ($row, $col) = $line->coord_of ($offset)
		919
		920	Translates a string offset into terminal coordinates again.
		921
		922	=back
		923
		924	=cut
		925
		926	sub urxvt::term::line {
		927	my ($self, $row) = @_;
		928
		929	my $maxrow = $self->nrow - 1;
		930
		931	my ($beg, $end) = ($row, $row);
		932
		933	--$beg while $self->ROW_is_longer ($beg - 1);
		934	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		935
		936	bless {
		937	term => $self,
		938	beg => $beg,
		939	end => $end,
		940	ncol => $self->ncol,
		941	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		942	}, urxvt::line::
		943	}
		944
		945	sub urxvt::line::t {
		946	my ($self) = @_;
		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 &&
		955	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		956	0, $self->{len}
		957	}
		958
		959	sub urxvt::line::r {
		960	my ($self) = @_;
		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) {
		969	my $rend = [
		970	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		971	];
		972	$#$rend = $self->{len} - 1;
		973	return $rend;
		974	}
		975
		976	()
		977	}
		978
		979	sub urxvt::line::beg { $_[0]{beg} }
		980	sub urxvt::line::end { $_[0]{end} }
		981	sub urxvt::line::l { $_[0]{len} }
		982
		983	sub urxvt::line::offset_of {
		984	my ($self, $row, $col) = @_;
		985
		986	($row - $self->{beg}) * $self->{ncol} + $col
		987	}
		988
		989	sub urxvt::line::coord_of {
		990	my ($self, $offset) = @_;
		991
		992	use integer;
		993
		994	(
		995	$offset / $self->{ncol} + $self->{beg},
		996	$offset % $self->{ncol}
		997	)
		998	}
		999
		1000	=item ($row, $col) = $line->coord_of ($offset)
583	=item $text = $term->special_encode $string	1001	=item $text = $term->special_encode $string
584		1002
585	Converts a perl string into the special encoding used by rxvt-unicode,	1003	Converts a perl string into the special encoding used by rxvt-unicode,
586	where one character corresponds to one screen cell. See	1004	where one character corresponds to one screen cell. See
587	C<< $term->ROW_t >> for details.	1005	C<< $term->ROW_t >> for details.
…		…
590		1008
591	Converts rxvt-unicodes text reprsentation into a perl string. See	1009	Converts rxvt-unicodes text reprsentation into a perl string. See
592	C<< $term->ROW_t >> for details.	1010	C<< $term->ROW_t >> for details.
593		1011
594	=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	}
595		1066
596	=head2 The C<urxvt::timer> Class	1067	=head2 The C<urxvt::timer> Class
597		1068
598	This class implements timer watchers/events. Time is represented as a	1069	This class implements timer watchers/events. Time is represented as a
599	fractional number of seconds since the epoch. Example:	1070	fractional number of seconds since the epoch. Example:
…		…
701	This variable controls the verbosity level of the perl extension. Higher	1172	This variable controls the verbosity level of the perl extension. Higher
702	numbers indicate more verbose output.	1173	numbers indicate more verbose output.
703		1174
704	=over 4	1175	=over 4
705		1176
706	=item 0 - only fatal messages	1177	=item =0 - only fatal messages
707		1178
708	=item 3 - script loading and management	1179	=item =3 - script loading and management
709		1180
710	=item 10 - all events received	1181	=item =10 - all events received
711		1182
712	=back	1183	=back
713		1184
714	=head1 AUTHOR	1185	=head1 AUTHOR
715		1186

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.22 by root, Tue Jan 3 19:10:54 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.22 by root, Tue Jan 3 19:10:54 2006 UTC vs.
Revision 1.49 by root, Sun Jan 8 00:07:18 2006 UTC