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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.28 by root, Wed Jan 4 00:09:12 2006 UTC vs.
Revision 1.50 by root, Sun Jan 8 00:11:38 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
…		…
59	=back	59	=back
60		60
61	=item digital-clock	61	=item digital-clock
62		62
63	Displays a digital clock using the built-in overlay.	63	Displays a digital clock using the built-in overlay.
		64
		65	=item mark-urls
		66
		67	Uses per-line display filtering (C<on_line_update>) to underline urls.
		68
		69	=item block-graphics-to-ascii
		70
		71	A not very useful example of filtering all text output to the terminal,
		72	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		73	similar-looking ascii character.
64		74
65	=item example-refresh-hooks	75	=item example-refresh-hooks
66		76
67	Displays a very simple digital clock in the upper right corner of the	77	Displays a very simple digital clock in the upper right corner of the
68	window. Illustrates overwriting the refresh callbacks to create your own	78	window. Illustrates overwriting the refresh callbacks to create your own
…		…
81	When objects are destroyed on the C++ side, the perl object hashes are	91	When objects are destroyed on the C++ side, the perl object hashes are
82	emptied, so its best to store related objects such as time watchers and	92	emptied, so its best to store related objects such as time watchers and
83	the like inside the terminal object so they get destroyed as soon as the	93	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	94	terminal is destroyed.
85		95
		96	Argument names also often indicate the type of a parameter. Here are some
		97	hints on what they mean:
		98
		99	=over 4
		100
		101	=item $text
		102
		103	Rxvt-unicodes special way of encoding text, where one "unicode" character
		104	always represents one screen cell. See L<row_t> for a discussion of this format.
		105
		106	=item $string
		107
		108	A perl text string, with an emphasis on I<text>. It can store all unicode
		109	characters and is to be distinguished with text encoded in a specific
		110	encoding (often locale-specific) and binary data.
		111
		112	=item $octets
		113
		114	Either binary data or - more common - a text string encoded in a
		115	locale-specific way.
		116
		117	=back
		118
86	=head2 Hooks	119	=head2 Hooks
87		120
88	The following subroutines can be declared in loaded scripts, and will be	121	The following subroutines can be declared in extension files, and will be
89	called whenever the relevant event happens.	122	called whenever the relevant event happens.
90		123
91	The first argument passed to them is an object private to each terminal	124	The first argument passed to them is an object private to each terminal
92	and extension package. You can call all C<urxvt::term> methods on it, but	125	and extension package. You can call all C<urxvt::term> methods on it, but
93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>	126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94	object that is shared between all packages is stored in the C<term>	127	object that is shared between all packages is stored in the C<term>
95	member.	128	member. It is, however, blessed intot he package of the extension script,
		129	so for all practical purposes you can treat an extension script as a class.
96		130
97	All of them must return a boolean value. If it is true, then the event	131	All of them must return a boolean value. If it is true, then the event
98	counts as being I<consumed>, and the invocation of other hooks is skipped,	132	counts as being I<consumed>, and the invocation of other hooks is skipped,
99	and the relevant action might not be carried out by the C++ code.	133	and the relevant action might not be carried out by the C++ code.
100		134
…		…
103	=over 4	137	=over 4
104		138
105	=item on_init $term	139	=item on_init $term
106		140
107	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
108	windows are created or the command gets run.	142	windows are created or the command gets run. Most methods are unsafe to
		143	call or deliver senseless data, as terminal size and other characteristics
		144	have not yet been determined. You can safely query and change resources,
		145	though.
109		146
110	=item on_reset $term	147	=item on_reset $term
111		148
112	Called after the screen is "reset" for any reason, such as resizing or	149	Called after the screen is "reset" for any reason, such as resizing or
113	control sequences. Here is where you can react on changes to size-related	150	control sequences. Here is where you can react on changes to size-related
…		…
142	should extend the selection itelf and return true to suppress the built-in	179	should extend the selection itelf and return true to suppress the built-in
143	processing.	180	processing.
144		181
145	See the F<selection> example extension.	182	See the F<selection> example extension.
146		183
147	=item on_focus_in $term
148
149	Called whenever the window gets the keyboard focus, before urxvt does
150	focus in processing.
151
152	=item on_focus_out $term
153
154	Called wheneever the window loses keyboard focus, before urxvt does focus
155	out processing.
156
157	=item on_view_change $term, $offset	184	=item on_view_change $term, $offset
158		185
159	Called whenever the view offset changes, i..e the user or program	186	Called whenever the view offset changes, i..e the user or program
160	scrolls. Offset C<0> means display the normal terminal, positive values	187	scrolls. Offset C<0> means display the normal terminal, positive values
161	show this many lines of scrollback.	188	show this many lines of scrollback.
…		…
174		201
175	Called whenever the program(s) running in the urxvt window send output.	202	Called whenever the program(s) running in the urxvt window send output.
176		203
177	=item on_osc_seq $term, $string	204	=item on_osc_seq $term, $string
178		205
179	Called whenever the B<ESC ] 777 ; string ST> command sequence is	206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180	processed. Cursor position and other state information is up-to-date when	207	operating system command) is processed. Cursor position and other state
181	this happens. For interoperability, the string should start with the	208	information is up-to-date when this happens. For interoperability, the
182	extension name and a colon, to distinguish it from commands for other	209	string should start with the extension name and a colon, to distinguish
183	extensions, and this might be enforced in the future.	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.
184		238
185	=item on_refresh_begin $term	239	=item on_refresh_begin $term
186		240
187	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
188	or similar effects by modify terminal contents in refresh_begin, and	242	or similar effects by modify terminal contents in refresh_begin, and
…		…
197		251
198	Called whenever the user presses a key combination that has a	252	Called whenever the user presses a key combination that has a
199	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>
200	resource in the @@RXVT_NAME@@(1) manpage).	254	resource in the @@RXVT_NAME@@(1) manpage).
201		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
202	=back	292	=back
203		293
204	=head2 Variables in the C<urxvt> Package	294	=head2 Variables in the C<urxvt> Package
205		295
206	=over 4	296	=over 4
207		297
208	=item $urxvt::TERM	298	=item $urxvt::TERM
209		299
210	The current terminal. Whenever a callback/Hook is bein executed, this	300	The current terminal. This variable stores the current C<urxvt::term>
211	variable stores the current C<urxvt::term> object.	301	object, whenever a callback/hook is executing.
212		302
213	=back	303	=back
214		304
215	=head2 Functions in the C<urxvt> Package	305	=head2 Functions in the C<urxvt> Package
216		306
217	=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.
218		316
219	=item urxvt::fatal $errormessage	317	=item urxvt::fatal $errormessage
220		318
221	Fatally aborts execution with the given error message. Avoid at all	319	Fatally aborts execution with the given error message. Avoid at all
222	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
…		…
232	correct place, e.g. on stderr of the connecting urxvtc client.	330	correct place, e.g. on stderr of the connecting urxvtc client.
233		331
234	=item $time = urxvt::NOW	332	=item $time = urxvt::NOW
235		333
236	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.
237		343
238	=back	344	=back
239		345
240	=head2 RENDITION	346	=head2 RENDITION
241		347
…		…
291		397
292	=cut	398	=cut
293		399
294	package urxvt;	400	package urxvt;
295		401
		402	use utf8;
296	use strict;	403	use strict;
297	use Scalar::Util ();	404	use Scalar::Util ();
		405	use List::Util ();
298		406
299	our $TERM;	407	our $TERM;
300	our @HOOKNAME;	408	our @HOOKNAME;
		409	our %OPTION;
301	our $LIBDIR;	410	our $LIBDIR;
302		411
303	BEGIN {	412	BEGIN {
304	urxvt->bootstrap;	413	urxvt->bootstrap;
305		414
…		…
335	$hook_count[$htype]++	444	$hook_count[$htype]++
336	or set_should_invoke $htype, 1;	445	or set_should_invoke $htype, 1;
337	}	446	}
338	}	447	}
339		448
340	my $script_pkg = "script0000";	449	my $extension_pkg = "extension0000";
341	my %script_pkg;	450	my %extension_pkg;
342		451
343	# load a single script into its own package, once only	452	# load a single script into its own package, once only
344	sub script_package($) {	453	sub extension_package($) {
345	my ($path) = @_;	454	my ($path) = @_;
346		455
347	$script_pkg{$path} \|\|= do {	456	$extension_pkg{$path} \|\|= do {
348	my $pkg = "urxvt::" . ($script_pkg++);	457	my $pkg = "urxvt::" . ($extension_pkg++);
349		458
350	verbose 3, "loading script '$path' into package '$pkg'";	459	verbose 3, "loading extension '$path' into package '$pkg'";
351		460
352	open my $fh, "<:raw", $path	461	open my $fh, "<:raw", $path
353	or die "$path: $!";	462	or die "$path: $!";
354		463
355	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"
356	. "#line 1 \"$path\"\n{\n"	466	. "#line 1 \"$path\"\n{\n"
357	. (do { local $/; <$fh> })	467	. (do { local $/; <$fh> })
358	. "\n};\n1";	468	. "\n};\n1";
359		469
360	eval $source or die "$path: $@";	470	eval $source or die "$path: $@";
361		471
362	$pkg	472	$pkg
363	}	473	}
364	}	474	}
		475
		476	our $retval; # return value for urxvt
365		477
366	# called by the rxvt core	478	# called by the rxvt core
367	sub invoke {	479	sub invoke {
368	local $TERM = shift;	480	local $TERM = shift;
369	my $htype = shift;	481	my $htype = shift;
370		482
371	if ($htype == 0) { # INIT	483	if ($htype == 0) { # INIT
372	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	484	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		485
		486	my %want_ext;
373		487
374	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);
		491	} elsif (/-(.*)/) {
		492	delete $want_ext{$1};
		493	} else {
		494	$want_ext{$_}++;
		495	}
		496	}
		497
		498	for my $ext (keys %want_ext) {
375	my @files = grep -f $_, map "$_/$ext", @dirs;	499	my @files = grep -f $_, map "$_/$ext", @dirs;
376		500
377	if (@files) {	501	if (@files) {
378	register_package script_package $files[0];	502	register_package extension_package $files[0];
379	} else {	503	} else {
380	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";
381	}	505	}
382	}	506	}
		507	}
383		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
384	} elsif ($htype == 1) { # DESTROY	532	if ($htype == 1) { # DESTROY
		533	# remove hooks if unused
385	if (my $hook = $TERM->{_hook}) {	534	if (my $hook = $TERM->{_hook}) {
386	for my $htype (0..$#$hook) {	535	for my $htype (0..$#$hook) {
387	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	536	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
388	or set_should_invoke $htype, 0;	537	or set_should_invoke $htype, 0;
389	}	538	}
390	}	539	}
		540
		541	# clear package objects
		542	%$_ = () for values %{ $TERM->{_pkg} };
		543
		544	# clear package
		545	%$TERM = ();
391	}	546	}
392		547
393	my $cb = $TERM->{_hook}[$htype]	548	$retval
394	or return;
395
396	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
397	if $verbosity >= 10;
398
399	keys %$cb;
400
401	while (my ($pkg, $cb) = each %$cb) {
402	return 1
403	if $cb->(
404	$TERM->{$pkg} \|\|= do {
405	my $proxy = bless { }, urxvt::term::proxy::;
406	Scalar::Util::weaken ($proxy->{term} = $TERM);
407	$proxy
408	},
409	@_,
410	);
411	}
412
413	0
414	}	549	}
415		550
416	sub urxvt::term::proxy::AUTOLOAD {	551	sub urxvt::term::proxy::AUTOLOAD {
417	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	552	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
418	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	553	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
…		…
426	} or die "FATAL: unable to compile method forwarder: $@";	561	} or die "FATAL: unable to compile method forwarder: $@";
427		562
428	goto &$urxvt::term::proxy::AUTOLOAD;	563	goto &$urxvt::term::proxy::AUTOLOAD;
429	}	564	}
430		565
		566	sub urxvt::destroy_hook::DESTROY {
		567	${$_[0]}->();
		568	}
		569
		570	sub urxvt::destroy_hook(&) {
		571	bless \shift, urxvt::destroy_hook::
		572	}
		573
431	=head2 The C<urxvt::term> Class	574	=head2 The C<urxvt::term> Class
432		575
433	=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
434		597
435	=item $value = $term->resource ($name[, $newval])	598	=item $value = $term->resource ($name[, $newval])
436		599
437	Returns the current resource value associated with a given name and	600	Returns the current resource value associated with a given name and
438	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>
…		…
448		611
449	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
450	terminal is destroyed, so changing options frequently will eat memory.	613	terminal is destroyed, so changing options frequently will eat memory.
451		614
452	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
453	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>
454	list:	617	to see the actual list:
455		618
456	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	619	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
457	borderLess color cursorBlink cursorUnderline cutchars delete_key	620	borderLess color cursorBlink cursorUnderline cutchars delete_key
458	display_name embed ext_bwidth fade font geometry hold iconName	621	display_name embed ext_bwidth fade font geometry hold iconName
459	imFont imLocale inputMethod insecure int_bwidth intensityStyles	622	imFont imLocale inputMethod insecure int_bwidth intensityStyles
460	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	623	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
461	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	624	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
462	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	625	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
463	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	626	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
464	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	627	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
465	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	628	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
466	shade term_name title transparent transparent_all tripleclickwords	629	shade term_name title transparent transparent_all tripleclickwords
…		…
469	=cut	632	=cut
470		633
471	sub urxvt::term::resource($$;$) {	634	sub urxvt::term::resource($$;$) {
472	my ($self, $name) = (shift, shift);	635	my ($self, $name) = (shift, shift);
473	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	636	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
474	goto &urxvt::term::_resource;	637	&urxvt::term::_resource
475	}	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).
476		649
477	=item ($row, $col) = $term->selection_mark ([$row, $col])	650	=item ($row, $col) = $term->selection_mark ([$row, $col])
478		651
479	=item ($row, $col) = $term->selection_beg ([$row, $col])	652	=item ($row, $col) = $term->selection_beg ([$row, $col])
480		653
…		…
495	#=item $term->overlay ($x, $y, $text)	668	#=item $term->overlay ($x, $y, $text)
496	#	669	#
497	#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.
498	#	671	#
499	#=cut	672	#=cut
500		673	#
501	sub urxvt::term::scr_overlay {	674	#sub urxvt::term::scr_overlay {
502	die;
503	my ($self, $x, $y, $text) = @_;	675	# my ($self, $x, $y, $text) = @_;
504		676	#
505	my @lines = split /\n/, $text;	677	# my @lines = split /\n/, $text;
506		678	#
507	my $w = 0;	679	# my $w = 0;
508	for (map $self->strwidth ($_), @lines) {	680	# for (map $self->strwidth ($_), @lines) {
509	$w = $_ if $w < $_;	681	# $w = $_ if $w < $_;
510	}	682	# }
511		683	#
512	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	684	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
513	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	685	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
514	}	686	#}
515		687
516	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	688	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
517		689
518	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
519	width/height. C<$rstyle> defines the initial rendition style	691	width/height. C<$rstyle> defines the initial rendition style
…		…
546		718
547	If hidden, display the overlay again.	719	If hidden, display the overlay again.
548		720
549	=back	721	=back
550		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
551	=item $cellwidth = $term->strwidth $string	750	=item $cellwidth = $term->strwidth ($string)
552		751
553	Returns the number of screen-cells this string would need. Correctly	752	Returns the number of screen-cells this string would need. Correctly
554	accounts for wide and combining characters.	753	accounts for wide and combining characters.
555		754
556	=item $octets = $term->locale_encode $string	755	=item $octets = $term->locale_encode ($string)
557		756
558	Convert the given text string into the corresponding locale encoding.	757	Convert the given text string into the corresponding locale encoding.
559		758
560	=item $string = $term->locale_decode $octets	759	=item $string = $term->locale_decode ($octets)
561		760
562	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.
563		779
564	=item $term->tt_write ($octets)	780	=item $term->tt_write ($octets)
565		781
566	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
567	pass characters instead of octets, you should convert your strings first	783	pass characters instead of octets, you should convert your strings first
568	to the locale-specific encoding using C<< $term->locale_encode >>.	784	to the locale-specific encoding using C<< $term->locale_encode >>.
569		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
570	=item $nrow = $term->nrow	804	=item $terminal_rows = $term->nrow
571		805
572	=item $ncol = $term->ncol	806	=item $terminal_columns = $term->ncol
573		807
574	Return the number of rows/columns of the terminal window (i.e. as	808	=item $has_focus = $term->focus
575	specified by C<-geometry>, excluding any scrollback).
576		809
577	=item $nsaved = $term->nsaved	810	=item $is_mapped = $term->mapped
578		811
579	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.
580		828
581	=item $view_start = $term->view_start ([$newvalue])	829	=item $view_start = $term->view_start ([$newvalue])
582		830
583	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
584	C<0>, which displays the normal terminal contents. Larger values scroll	832	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
647	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
648	following methods:	896	following methods:
649		897
650	=over 4	898	=over 4
651		899
652	=item $text = $line->t	900	=item $text = $line->t ([$new_text])
653		901
654	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>
655		903
656	=item $rend = $line->r	904	=item $rend = $line->r ([$new_rend])
657		905
658	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>
659		907
660	=item $length = $line->l	908	=item $length = $line->l
661		909
662	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>.
663		911
…		…
692		940
693	bless {	941	bless {
694	term => $self,	942	term => $self,
695	beg => $beg,	943	beg => $beg,
696	end => $end,	944	end => $end,
		945	ncol => $self->ncol,
697	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	946	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
698	}, urxvt::line::	947	}, urxvt::line::
699	}	948	}
700		949
701	sub urxvt::line::t {	950	sub urxvt::line::t {
702	my ($self) = @_;	951	my ($self) = @_;
703		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 &&
704	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	960	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
705	0, $self->{len}	961	0, $self->{len}
706	}	962	}
707		963
708	sub urxvt::line::r {	964	sub urxvt::line::r {
709	my ($self) = @_;	965	my ($self) = @_;
710		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) {
711	my $rend = [	974	my $rend = [
712	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	975	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
713	];	976	];
714	$#$rend = $self->{len} - 1;	977	$#$rend = $self->{len} - 1;
715	$rend	978	return $rend;
		979	}
		980
		981	()
716	}	982	}
717		983
718	sub urxvt::line::beg { $_[0]{beg} }	984	sub urxvt::line::beg { $_[0]{beg} }
719	sub urxvt::line::end { $_[0]{end} }	985	sub urxvt::line::end { $_[0]{end} }
720	sub urxvt::line::l { $_[0]{len} }	986	sub urxvt::line::l { $_[0]{len} }
721		987
722	sub urxvt::line::offset_of {	988	sub urxvt::line::offset_of {
723	my ($self, $row, $col) = @_;	989	my ($self, $row, $col) = @_;
724		990
725	($row - $self->{beg}) * $self->{term}->ncol + $col	991	($row - $self->{beg}) * $self->{ncol} + $col
726	}	992	}
727		993
728	sub urxvt::line::coord_of {	994	sub urxvt::line::coord_of {
729	my ($self, $offset) = @_;	995	my ($self, $offset) = @_;
730		996
731	use integer;	997	use integer;
732		998
733	(	999	(
734	$offset / $self->{term}->ncol + $self->{beg},	1000	$offset / $self->{ncol} + $self->{beg},
735	$offset % $self->{term}->ncol	1001	$offset % $self->{ncol}
736	)	1002	)
737	}	1003	}
738		1004
739	=item ($row, $col) = $line->coord_of ($offset)	1005	=item ($row, $col) = $line->coord_of ($offset)
740	=item $text = $term->special_encode $string	1006	=item $text = $term->special_encode $string
…		…
747		1013
748	Converts rxvt-unicodes text reprsentation into a perl string. See	1014	Converts rxvt-unicodes text reprsentation into a perl string. See
749	C<< $term->ROW_t >> for details.	1015	C<< $term->ROW_t >> for details.
750		1016
751	=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	push @{ $self->{item} }, $item;
		1031	}
		1032
		1033	sub add_button {
		1034	my ($self, $text, $cb) = @_;
		1035
		1036	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,
		1037	render => sub { $_[0]{text} },
		1038	});
		1039	}
		1040
		1041	sub add_toggle {
		1042	my ($self, $text, $cb, $value) = @_;
		1043
		1044	my $item; $item = {
		1045	type => "button",
		1046	text => " $text",
		1047	value => $value,
		1048	render => sub { ($item->{value} ? "✔" : " ") . $text },
		1049	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1050	};
		1051
		1052	$self->add_item ($item);
		1053	}
		1054
		1055	sub show {
		1056	my ($self) = @_;
		1057
		1058	local $urxvt::popup::self = $self;
		1059
		1060	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1061	"--transient-for" => $self->{term}->parent,
		1062	"-pe" => "urxvt-popup")
		1063	or die "unable to create popup window\n";
		1064	}
		1065
		1066	sub DESTROY {
		1067	my ($self) = @_;
		1068
		1069	$self->{term}->ungrab;
		1070	}
752		1071
753	=head2 The C<urxvt::timer> Class	1072	=head2 The C<urxvt::timer> Class
754		1073
755	This class implements timer watchers/events. Time is represented as a	1074	This class implements timer watchers/events. Time is represented as a
756	fractional number of seconds since the epoch. Example:	1075	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.28 by root, Wed Jan 4 00:09:12 2006 UTC vs. Revision 1.50 by root, Sun Jan 8 00:11:38 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.28 by root, Wed Jan 4 00:09:12 2006 UTC vs.
Revision 1.50 by root, Sun Jan 8 00:11:38 2006 UTC