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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC vs.
Revision 1.53 by root, Sun Jan 8 01:16:09 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
…		…
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	121	The following subroutines can be declared in extension files, and will be
87	called whenever the relevant event happens.	122	called whenever the relevant event happens.
88		123
89	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
90	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
91	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>
92	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>
93	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.
94		130
95	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
96	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,
97	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.
98		134
…		…
101	=over 4	137	=over 4
102		138
103	=item on_init $term	139	=item on_init $term
104		140
105	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
106	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.
107		146
108	=item on_reset $term	147	=item on_reset $term
109		148
110	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
111	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
…		…
140	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
141	processing.	180	processing.
142		181
143	See the F<selection> example extension.	182	See the F<selection> example extension.
144		183
145	=item on_focus_in $term
146
147	Called whenever the window gets the keyboard focus, before urxvt does
148	focus in processing.
149
150	=item on_focus_out $term
151
152	Called wheneever the window loses keyboard focus, before urxvt does focus
153	out processing.
154
155	=item on_view_change $term, $offset	184	=item on_view_change $term, $offset
156		185
157	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
158	scrolls. Offset C<0> means display the normal terminal, positive values	187	scrolls. Offset C<0> means display the normal terminal, positive values
159	show this many lines of scrollback.	188	show this many lines of scrollback.
…		…
169	number of lines that will be in the scrollback buffer.	198	number of lines that will be in the scrollback buffer.
170		199
171	=item on_tty_activity $term NYI	200	=item on_tty_activity $term NYI
172		201
173	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.
174		238
175	=item on_refresh_begin $term	239	=item on_refresh_begin $term
176		240
177	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
178	or similar effects by modify terminal contents in refresh_begin, and	242	or similar effects by modify terminal contents in refresh_begin, and
…		…
187		251
188	Called whenever the user presses a key combination that has a	252	Called whenever the user presses a key combination that has a
189	C<perl:string> action bound to it (see description of the B<keysym>	253	C<perl:string> action bound to it (see description of the B<keysym>
190	resource in the @@RXVT_NAME@@(1) manpage).	254	resource in the @@RXVT_NAME@@(1) manpage).
191		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
192	=back	292	=back
193		293
194	=head2 Variables in the C<urxvt> Package	294	=head2 Variables in the C<urxvt> Package
195		295
196	=over 4	296	=over 4
197		297
198	=item $urxvt::TERM	298	=item $urxvt::TERM
199		299
200	The current terminal. Whenever a callback/Hook is bein executed, this	300	The current terminal. This variable stores the current C<urxvt::term>
201	variable stores the current C<urxvt::term> object.	301	object, whenever a callback/hook is executing.
202		302
203	=back	303	=back
204		304
205	=head2 Functions in the C<urxvt> Package	305	=head2 Functions in the C<urxvt> Package
206		306
207	=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.
208		316
209	=item urxvt::fatal $errormessage	317	=item urxvt::fatal $errormessage
210		318
211	Fatally aborts execution with the given error message. Avoid at all	319	Fatally aborts execution with the given error message. Avoid at all
212	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
…		…
222	correct place, e.g. on stderr of the connecting urxvtc client.	330	correct place, e.g. on stderr of the connecting urxvtc client.
223		331
224	=item $time = urxvt::NOW	332	=item $time = urxvt::NOW
225		333
226	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.
227		343
228	=back	344	=back
229		345
230	=head2 RENDITION	346	=head2 RENDITION
231		347
…		…
281		397
282	=cut	398	=cut
283		399
284	package urxvt;	400	package urxvt;
285		401
		402	use utf8;
286	use strict;	403	use strict;
287	use Scalar::Util ();	404	use Scalar::Util ();
		405	use List::Util ();
288		406
289	our $TERM;	407	our $TERM;
290	our @HOOKNAME;	408	our @HOOKNAME;
		409	our %OPTION;
291	our $LIBDIR;	410	our $LIBDIR;
292		411
293	BEGIN {	412	BEGIN {
294	urxvt->bootstrap;	413	urxvt->bootstrap;
295		414
…		…
325	$hook_count[$htype]++	444	$hook_count[$htype]++
326	or set_should_invoke $htype, 1;	445	or set_should_invoke $htype, 1;
327	}	446	}
328	}	447	}
329		448
330	my $script_pkg = "script0000";	449	my $extension_pkg = "extension0000";
331	my %script_pkg;	450	my %extension_pkg;
332		451
333	# load a single script into its own package, once only	452	# load a single script into its own package, once only
334	sub script_package($) {	453	sub extension_package($) {
335	my ($path) = @_;	454	my ($path) = @_;
336		455
337	$script_pkg{$path} \|\|= do {	456	$extension_pkg{$path} \|\|= do {
338	my $pkg = "urxvt::" . ($script_pkg++);	457	my $pkg = "urxvt::" . ($extension_pkg++);
339		458
340	verbose 3, "loading script '$path' into package '$pkg'";	459	verbose 3, "loading extension '$path' into package '$pkg'";
341		460
342	open my $fh, "<:raw", $path	461	open my $fh, "<:raw", $path
343	or die "$path: $!";	462	or die "$path: $!";
344		463
345	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"
346	. "#line 1 \"$path\"\n{\n"	466	. "#line 1 \"$path\"\n{\n"
347	. (do { local $/; <$fh> })	467	. (do { local $/; <$fh> })
348	. "\n};\n1";	468	. "\n};\n1";
349		469
350	eval $source or die "$path: $@";	470	eval $source or die "$path: $@";
351		471
352	$pkg	472	$pkg
353	}	473	}
354	}	474	}
		475
		476	our $retval; # return value for urxvt
355		477
356	# called by the rxvt core	478	# called by the rxvt core
357	sub invoke {	479	sub invoke {
358	local $TERM = shift;	480	local $TERM = shift;
359	my $htype = shift;	481	my $htype = shift;
360		482
361	if ($htype == 0) { # INIT	483	if ($htype == 0) { # INIT
362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	484	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		485
		486	my %want_ext;
363		487
364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	488	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		489	if ($_ eq "default") {
		490	$want_ext{$_}++ for qw(selection option-popup);
		491	} elsif (/^-(.*)$/) {
		492	delete $want_ext{$1};
		493	} else {
		494	$want_ext{$_}++;
		495	}
		496	}
		497
		498	for my $ext (keys %want_ext) {
365	my @files = grep -f $_, map "$_/$ext", @dirs;	499	my @files = grep -f $_, map "$_/$ext", @dirs;
366		500
367	if (@files) {	501	if (@files) {
368	register_package script_package $files[0];	502	register_package extension_package $files[0];
369	} else {	503	} else {
370	warn "perl extension '$ext' not found in perl library search path\n";	504	warn "perl extension '$ext' not found in perl library search path\n";
371	}	505	}
372	}	506	}
		507	}
373		508
		509	$retval = undef;
		510
		511	if (my $cb = $TERM->{_hook}[$htype]) {
		512	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		513	if $verbosity >= 10;
		514
		515	keys %$cb;
		516
		517	while (my ($pkg, $cb) = each %$cb) {
		518	eval {
		519	$retval = $cb->(
		520	$TERM->{_pkg}{$pkg} \|\|= do {
		521	my $proxy = bless { }, $pkg;
		522	Scalar::Util::weaken ($proxy->{term} = $TERM);
		523	$proxy
		524	},
		525	@_,
		526	) and last;
		527	};
		528	warn $@ if $@;#d#
		529	}
		530	}
		531
374	} elsif ($htype == 1) { # DESTROY	532	if ($htype == 1) { # DESTROY
		533	# remove hooks if unused
375	if (my $hook = $TERM->{_hook}) {	534	if (my $hook = $TERM->{_hook}) {
376	for my $htype (0..$#$hook) {	535	for my $htype (0..$#$hook) {
377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	536	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
378	or set_should_invoke $htype, 0;	537	or set_should_invoke $htype, 0;
379	}	538	}
380	}	539	}
		540
		541	# clear package objects
		542	%$_ = () for values %{ $TERM->{_pkg} };
		543
		544	# clear package
		545	%$TERM = ();
381	}	546	}
382		547
383	my $cb = $TERM->{_hook}[$htype]	548	$retval
384	or return;
385
386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
387	if $verbosity >= 10;
388
389	keys %$cb;
390
391	while (my ($pkg, $cb) = each %$cb) {
392	return 1
393	if $cb->(
394	$TERM->{$pkg} \|\|= do {
395	my $proxy = bless { }, urxvt::term::proxy::;
396	Scalar::Util::weaken ($proxy->{term} = $TERM);
397	$proxy
398	},
399	@_,
400	);
401	}
402
403	0
404	}	549	}
405		550
406	sub urxvt::term::proxy::AUTOLOAD {	551	sub urxvt::term::proxy::AUTOLOAD {
407	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	552	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
408	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	553	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
…		…
416	} or die "FATAL: unable to compile method forwarder: $@";	561	} or die "FATAL: unable to compile method forwarder: $@";
417		562
418	goto &$urxvt::term::proxy::AUTOLOAD;	563	goto &$urxvt::term::proxy::AUTOLOAD;
419	}	564	}
420		565
		566	sub urxvt::destroy_hook::DESTROY {
		567	${$_[0]}->();
		568	}
		569
		570	sub urxvt::destroy_hook(&) {
		571	bless \shift, urxvt::destroy_hook::
		572	}
		573
421	=head2 The C<urxvt::term> Class	574	=head2 The C<urxvt::term> Class
422		575
423	=over 4	576	=over 4
		577
		578	=item $term->destroy
		579
		580	Destroy the terminal object (close the window, free resources etc.).
		581
		582	=item $isset = $term->option ($optval[, $set])
		583
		584	Returns true if the option specified by C<$optval> is enabled, and
		585	optionally change it. All option values are stored by name in the hash
		586	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		587
		588	Here is a a likely non-exhaustive list of option names, please see the
		589	source file F</src/optinc.h> to see the actual list:
		590
		591	borderLess console cursorBlink cursorUnderline hold iconic insecure
		592	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		593	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		594	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		595	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		596	tripleclickwords utmpInhibit visualBell
424		597
425	=item $value = $term->resource ($name[, $newval])	598	=item $value = $term->resource ($name[, $newval])
426		599
427	Returns the current resource value associated with a given name and	600	Returns the current resource value associated with a given name and
428	optionally sets a new value. Setting values is most useful in the C<init>	601	optionally sets a new value. Setting values is most useful in the C<init>
…		…
438		611
439	Please note that resource strings will currently only be freed when the	612	Please note that resource strings will currently only be freed when the
440	terminal is destroyed, so changing options frequently will eat memory.	613	terminal is destroyed, so changing options frequently will eat memory.
441		614
442	Here is a a likely non-exhaustive list of resource names, not all of which	615	Here is a a likely non-exhaustive list of resource names, not all of which
443	are supported in every build, please see the source to see the actual	616	are supported in every build, please see the source file F</src/rsinc.h>
444	list:	617	to see the actual list:
445		618
446	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	619	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447	borderLess color cursorBlink cursorUnderline cutchars delete_key	620	borderLess color cursorBlink cursorUnderline cutchars delete_key
448	display_name embed ext_bwidth fade font geometry hold iconName	621	display_name embed ext_bwidth fade font geometry hold iconName
449	imFont imLocale inputMethod insecure int_bwidth intensityStyles	622	imFont imLocale inputMethod insecure int_bwidth intensityStyles
450	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	623	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
451	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	624	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
452	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	625	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
453	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	626	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
454	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	627	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
455	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	628	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
456	shade term_name title transparent transparent_all tripleclickwords	629	shade term_name title transparent transparent_all tripleclickwords
…		…
459	=cut	632	=cut
460		633
461	sub urxvt::term::resource($$;$) {	634	sub urxvt::term::resource($$;$) {
462	my ($self, $name) = (shift, shift);	635	my ($self, $name) = (shift, shift);
463	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	636	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
464	goto &urxvt::term::_resource;	637	&urxvt::term::_resource
465	}	638	}
		639
		640	=item $rend = $term->rstyle ([$new_rstyle])
		641
		642	Return and optionally change the current rendition. Text that is output by
		643	the terminal application will use this style.
		644
		645	=item ($row, $col) = $term->screen_cur ([$row, $col])
		646
		647	Return the current coordinates of the text cursor position and optionally
		648	set it (which is usually bad as applications don't expect that).
466		649
467	=item ($row, $col) = $term->selection_mark ([$row, $col])	650	=item ($row, $col) = $term->selection_mark ([$row, $col])
468		651
469	=item ($row, $col) = $term->selection_beg ([$row, $col])	652	=item ($row, $col) = $term->selection_beg ([$row, $col])
470		653
…		…
485	#=item $term->overlay ($x, $y, $text)	668	#=item $term->overlay ($x, $y, $text)
486	#	669	#
487	#Create a simple multi-line overlay box. See the next method for details.	670	#Create a simple multi-line overlay box. See the next method for details.
488	#	671	#
489	#=cut	672	#=cut
490		673	#
491	sub urxvt::term::scr_overlay {	674	#sub urxvt::term::scr_overlay {
492	die;
493	my ($self, $x, $y, $text) = @_;	675	# my ($self, $x, $y, $text) = @_;
494		676	#
495	my @lines = split /\n/, $text;	677	# my @lines = split /\n/, $text;
496		678	#
497	my $w = 0;	679	# my $w = 0;
498	for (map $self->strwidth ($_), @lines) {	680	# for (map $self->strwidth ($_), @lines) {
499	$w = $_ if $w < $_;	681	# $w = $_ if $w < $_;
500	}	682	# }
501		683	#
502	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	684	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
503	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	685	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
504	}	686	#}
505		687
506	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	688	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
507		689
508	Create a new (empty) overlay at the given position with the given	690	Create a new (empty) overlay at the given position with the given
509	width/height. C<$rstyle> defines the initial rendition style	691	width/height. C<$rstyle> defines the initial rendition style
…		…
536		718
537	If hidden, display the overlay again.	719	If hidden, display the overlay again.
538		720
539	=back	721	=back
540		722
		723	=item $popup = $term->popup ($event)
		724
		725	Creates a new C<urxvt::popup> object that implements a popup menu. The
		726	C<$event> I<must> be the event causing the menu to pop up (a button event,
		727	currently).
		728
		729	=cut
		730
		731	sub urxvt::term::popup {
		732	my ($self, $event) = @_;
		733
		734	$self->grab ($event->{time}, 1)
		735	or return;
		736
		737	my $popup = bless {
		738	term => $self,
		739	event => $event,
		740	}, urxvt::popup::;
		741
		742	Scalar::Util::weaken $popup->{term};
		743
		744	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		745	Scalar::Util::weaken $self->{_destroy}{$popup};
		746
		747	$popup
		748	}
		749
541	=item $cellwidth = $term->strwidth $string	750	=item $cellwidth = $term->strwidth ($string)
542		751
543	Returns the number of screen-cells this string would need. Correctly	752	Returns the number of screen-cells this string would need. Correctly
544	accounts for wide and combining characters.	753	accounts for wide and combining characters.
545		754
546	=item $octets = $term->locale_encode $string	755	=item $octets = $term->locale_encode ($string)
547		756
548	Convert the given text string into the corresponding locale encoding.	757	Convert the given text string into the corresponding locale encoding.
549		758
550	=item $string = $term->locale_decode $octets	759	=item $string = $term->locale_decode ($octets)
551		760
552	Convert the given locale-encoded octets into a perl string.	761	Convert the given locale-encoded octets into a perl string.
		762
		763	=item $term->scr_add_lines ($string)
		764
		765	Write the given text string to the screen, as if output by the application
		766	running inside the terminal. It may not contain command sequences (escape
		767	codes), but is free to use line feeds, carriage returns and tabs. The
		768	string is a normal text string, not in locale-dependent encoding.
		769
		770	Normally its not a good idea to use this function, as programs might be
		771	confused by changes in cursor position or scrolling. Its useful inside a
		772	C<on_add_lines> hook, though.
		773
		774	=item $term->cmd_parse ($octets)
		775
		776	Similar to C<scr_add_lines>, but the argument must be in the
		777	locale-specific encoding of the terminal and can contain command sequences
		778	(escape codes) that will be interpreted.
553		779
554	=item $term->tt_write ($octets)	780	=item $term->tt_write ($octets)
555		781
556	Write the octets given in C<$data> to the tty (i.e. as program input). To	782	Write the octets given in C<$data> to the tty (i.e. as program input). To
557	pass characters instead of octets, you should convert your strings first	783	pass characters instead of octets, you should convert your strings first
558	to the locale-specific encoding using C<< $term->locale_encode >>.	784	to the locale-specific encoding using C<< $term->locale_encode >>.
559		785
		786	=item $windowid = $term->parent
		787
		788	Return the window id of the toplevel window.
		789
		790	=item $windowid = $term->vt
		791
		792	Return the window id of the terminal window.
		793
		794	=item $window_width = $term->width
		795
		796	=item $window_height = $term->height
		797
		798	=item $font_width = $term->fwidth
		799
		800	=item $font_height = $term->fheight
		801
		802	=item $font_ascent = $term->fbase
		803
560	=item $nrow = $term->nrow	804	=item $terminal_rows = $term->nrow
561		805
562	=item $ncol = $term->ncol	806	=item $terminal_columns = $term->ncol
563		807
564	Return the number of rows/columns of the terminal window (i.e. as	808	=item $has_focus = $term->focus
565	specified by C<-geometry>, excluding any scrollback).
566		809
567	=item $nsaved = $term->nsaved	810	=item $is_mapped = $term->mapped
568		811
569	Returns the number of lines in the scrollback buffer.	812	=item $max_scrollback = $term->saveLines
		813
		814	=item $nrow_plus_saveLines = $term->total_rows
		815
		816	=item $lines_in_scrollback = $term->nsaved
		817
		818	Return various integers describing terminal characteristics.
		819
		820	=item $modifiermask = $term->ModLevel3Mask
		821
		822	=item $modifiermask = $term->ModMetaMask
		823
		824	=item $modifiermask = $term->ModNumLockMask
		825
		826	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		827	AltGr), the meta key (often Alt) and the num lock key, if applicable.
570		828
571	=item $view_start = $term->view_start ([$newvalue])	829	=item $view_start = $term->view_start ([$newvalue])
572		830
573	Returns the negative row number of the topmost line. Minimum value is	831	Returns the negative row number of the topmost line. Minimum value is
574	C<0>, which displays the normal terminal contents. Larger values scroll	832	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
637	about the logical line that row C<$row_number> is part of. It supports the	895	about the logical line that row C<$row_number> is part of. It supports the
638	following methods:	896	following methods:
639		897
640	=over 4	898	=over 4
641		899
642	=item $text = $line->t	900	=item $text = $line->t ([$new_text])
643		901
644	Returns the full text of the line, similar to C<ROW_t>	902	Returns or replaces the full text of the line, similar to C<ROW_t>
645		903
646	=item $rend = $line->r	904	=item $rend = $line->r ([$new_rend])
647		905
648	Returns the full rendition array of the line, similar to C<ROW_r>	906	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
649		907
650	=item $length = $line->l	908	=item $length = $line->l
651		909
652	Returns the length of the line in cells, similar to C<ROW_l>.	910	Returns the length of the line in cells, similar to C<ROW_l>.
653		911
…		…
682		940
683	bless {	941	bless {
684	term => $self,	942	term => $self,
685	beg => $beg,	943	beg => $beg,
686	end => $end,	944	end => $end,
		945	ncol => $self->ncol,
687	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	946	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
688	}, urxvt::line::	947	}, urxvt::line::
689	}	948	}
690		949
691	sub urxvt::line::t {	950	sub urxvt::line::t {
692	my ($self) = @_;	951	my ($self) = @_;
693		952
		953	if (@_ > 1)
		954	{
		955	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		956	for $self->{beg} .. $self->{end};
		957	}
		958
		959	defined wantarray &&
694	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	960	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
695	0, $self->{len}	961	0, $self->{len}
696	}	962	}
697		963
698	sub urxvt::line::r {	964	sub urxvt::line::r {
699	my ($self) = @_;	965	my ($self) = @_;
700		966
		967	if (@_ > 1)
		968	{
		969	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		970	for $self->{beg} .. $self->{end};
		971	}
		972
		973	if (defined wantarray) {
701	my $rend = [	974	my $rend = [
702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	975	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
703	];	976	];
704	$#$rend = $self->{len} - 1;	977	$#$rend = $self->{len} - 1;
705	$rend	978	return $rend;
		979	}
		980
		981	()
706	}	982	}
707		983
708	sub urxvt::line::beg { $_[0]{beg} }	984	sub urxvt::line::beg { $_[0]{beg} }
709	sub urxvt::line::end { $_[0]{end} }	985	sub urxvt::line::end { $_[0]{end} }
710	sub urxvt::line::l { $_[0]{len} }	986	sub urxvt::line::l { $_[0]{len} }
711		987
712	sub urxvt::line::offset_of {	988	sub urxvt::line::offset_of {
713	my ($self, $row, $col) = @_;	989	my ($self, $row, $col) = @_;
714		990
715	($row - $self->{beg}) * $self->{term}->ncol + $col	991	($row - $self->{beg}) * $self->{ncol} + $col
716	}	992	}
717		993
718	sub urxvt::line::coord_of {	994	sub urxvt::line::coord_of {
719	my ($self, $offset) = @_;	995	my ($self, $offset) = @_;
720		996
721	use integer;	997	use integer;
722		998
723	(	999	(
724	$offset / $self->{term}->ncol + $self->{beg},	1000	$offset / $self->{ncol} + $self->{beg},
725	$offset % $self->{term}->ncol	1001	$offset % $self->{ncol}
726	)	1002	)
727	}	1003	}
728		1004
729	=item ($row, $col) = $line->coord_of ($offset)	1005	=item ($row, $col) = $line->coord_of ($offset)
730	=item $text = $term->special_encode $string	1006	=item $text = $term->special_encode $string
…		…
737		1013
738	Converts rxvt-unicodes text reprsentation into a perl string. See	1014	Converts rxvt-unicodes text reprsentation into a perl string. See
739	C<< $term->ROW_t >> for details.	1015	C<< $term->ROW_t >> for details.
740		1016
741	=back	1017	=back
		1018
		1019	=head2 The C<urxvt::popup> Class
		1020
		1021	=over 4
		1022
		1023	=cut
		1024
		1025	package urxvt::popup;
		1026
		1027	sub add_item {
		1028	my ($self, $item) = @_;
		1029
		1030	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1031	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1032	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1033
		1034	$item->{render} \|\|= sub { $_[0]{text} };
		1035
		1036	push @{ $self->{item} }, $item;
		1037	}
		1038
		1039	sub add_separator {
		1040	my ($self, $sep) = @_;
		1041
		1042	$sep \|\|= "═";
		1043
		1044	$self->add_item ({
		1045	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1046	text => "",
		1047	render => sub { $sep x $urxvt::TERM->ncol },
		1048	activate => sub { },
		1049	});
		1050	}
		1051
		1052	sub add_title {
		1053	my ($self, $title) = @_;
		1054
		1055	$self->add_item ({
		1056	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1057	text => $title,
		1058	activate => sub { },
		1059	});
		1060	}
		1061
		1062	sub add_button {
		1063	my ($self, $text, $cb) = @_;
		1064
		1065	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1066	}
		1067
		1068	sub add_toggle {
		1069	my ($self, $text, $cb, $value) = @_;
		1070
		1071	my $item; $item = {
		1072	type => "button",
		1073	text => " $text",
		1074	value => $value,
		1075	render => sub { ($item->{value} ? "* " : " ") . $text },
		1076	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1077	};
		1078
		1079	$self->add_item ($item);
		1080	}
		1081
		1082	sub show {
		1083	my ($self) = @_;
		1084
		1085	local $urxvt::popup::self = $self;
		1086
		1087	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1088	"--transient-for" => $self->{term}->parent,
		1089	"-pe" => "urxvt-popup")
		1090	or die "unable to create popup window\n";
		1091	}
		1092
		1093	sub DESTROY {
		1094	my ($self) = @_;
		1095
		1096	$self->{term}->ungrab;
		1097	}
742		1098
743	=head2 The C<urxvt::timer> Class	1099	=head2 The C<urxvt::timer> Class
744		1100
745	This class implements timer watchers/events. Time is represented as a	1101	This class implements timer watchers/events. Time is represented as a
746	fractional number of seconds since the epoch. Example:	1102	fractional number of seconds since the epoch. Example:
…		…
848	This variable controls the verbosity level of the perl extension. Higher	1204	This variable controls the verbosity level of the perl extension. Higher
849	numbers indicate more verbose output.	1205	numbers indicate more verbose output.
850		1206
851	=over 4	1207	=over 4
852		1208
853	=item 0 - only fatal messages	1209	=item =0 - only fatal messages
854		1210
855	=item 3 - script loading and management	1211	=item =3 - script loading and management
856		1212
857	=item 10 - all events received	1213	=item =10 - all events received
858		1214
859	=back	1215	=back
860		1216
861	=head1 AUTHOR	1217	=head1 AUTHOR
862		1218

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC vs. Revision 1.53 by root, Sun Jan 8 01:16:09 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC vs.
Revision 1.53 by root, Sun Jan 8 01:16:09 2006 UTC