[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.47 by root, Sat Jan 7 21:22:02 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
…		…
325	$hook_count[$htype]++	441	$hook_count[$htype]++
326	or set_should_invoke $htype, 1;	442	or set_should_invoke $htype, 1;
327	}	443	}
328	}	444	}
329		445
330	my $script_pkg = "script0000";	446	my $extension_pkg = "extension0000";
331	my %script_pkg;	447	my %extension_pkg;
332		448
333	# load a single script into its own package, once only	449	# load a single script into its own package, once only
334	sub script_package($) {	450	sub extension_package($) {
335	my ($path) = @_;	451	my ($path) = @_;
336		452
337	$script_pkg{$path} \|\|= do {	453	$extension_pkg{$path} \|\|= do {
338	my $pkg = "urxvt::" . ($script_pkg++);	454	my $pkg = "urxvt::" . ($extension_pkg++);
339		455
340	verbose 3, "loading script '$path' into package '$pkg'";	456	verbose 3, "loading extension '$path' into package '$pkg'";
341		457
342	open my $fh, "<:raw", $path	458	open my $fh, "<:raw", $path
343	or die "$path: $!";	459	or die "$path: $!";
344		460
345	my $source = "package $pkg; use strict; use utf8;\n"	461	my $source = "package $pkg; use strict; use utf8;\n"
		462	. "use base urxvt::term::proxy::;\n"
346	. "#line 1 \"$path\"\n{\n"	463	. "#line 1 \"$path\"\n{\n"
347	. (do { local $/; <$fh> })	464	. (do { local $/; <$fh> })
348	. "\n};\n1";	465	. "\n};\n1";
349		466
350	eval $source or die "$path: $@";	467	eval $source or die "$path: $@";
351		468
352	$pkg	469	$pkg
353	}	470	}
354	}	471	}
		472
		473	our $retval; # return value for urxvt
355		474
356	# called by the rxvt core	475	# called by the rxvt core
357	sub invoke {	476	sub invoke {
358	local $TERM = shift;	477	local $TERM = shift;
359	my $htype = shift;	478	my $htype = shift;
360		479
361	if ($htype == 0) { # INIT	480	if ($htype == 0) { # INIT
362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	481	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
363		482
364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	483	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
365	my @files = grep -f $_, map "$_/$ext", @dirs;	484	my @files = grep -f $_, map "$_/$ext", @dirs;
366		485
367	if (@files) {	486	if (@files) {
368	register_package script_package $files[0];	487	register_package extension_package $files[0];
369	} else {	488	} else {
370	warn "perl extension '$ext' not found in perl library search path\n";	489	warn "perl extension '$ext' not found in perl library search path\n";
371	}	490	}
372	}	491	}
		492	}
373		493
		494	$retval = undef;
		495
		496	if (my $cb = $TERM->{_hook}[$htype]) {
		497	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		498	if $verbosity >= 10;
		499
		500	keys %$cb;
		501
		502	while (my ($pkg, $cb) = each %$cb) {
		503	eval {
		504	$retval = $cb->(
		505	$TERM->{_pkg}{$pkg} \|\|= do {
		506	my $proxy = bless { }, $pkg;
		507	Scalar::Util::weaken ($proxy->{term} = $TERM);
		508	$proxy
		509	},
		510	@_,
		511	) and last;
		512	};
		513	warn $@ if $@;#d#
		514	}
		515	}
		516
374	} elsif ($htype == 1) { # DESTROY	517	if ($htype == 1) { # DESTROY
		518	# remove hooks if unused
375	if (my $hook = $TERM->{_hook}) {	519	if (my $hook = $TERM->{_hook}) {
376	for my $htype (0..$#$hook) {	520	for my $htype (0..$#$hook) {
377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	521	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
378	or set_should_invoke $htype, 0;	522	or set_should_invoke $htype, 0;
379	}	523	}
380	}	524	}
		525
		526	# clear package objects
		527	%$_ = () for values %{ $TERM->{_pkg} };
		528
		529	# clear package
		530	%$TERM = ();
381	}	531	}
382		532
383	my $cb = $TERM->{_hook}[$htype]	533	$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	}	534	}
405		535
406	sub urxvt::term::proxy::AUTOLOAD {	536	sub urxvt::term::proxy::AUTOLOAD {
407	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	537	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
408	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	538	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
…		…
416	} or die "FATAL: unable to compile method forwarder: $@";	546	} or die "FATAL: unable to compile method forwarder: $@";
417		547
418	goto &$urxvt::term::proxy::AUTOLOAD;	548	goto &$urxvt::term::proxy::AUTOLOAD;
419	}	549	}
420		550
		551	sub urxvt::destroy_hook::DESTROY {
		552	${$_[0]}->();
		553	}
		554
		555	sub urxvt::destroy_hook(&) {
		556	bless \shift, urxvt::destroy_hook::
		557	}
		558
421	=head2 The C<urxvt::term> Class	559	=head2 The C<urxvt::term> Class
422		560
423	=over 4	561	=over 4
		562
		563	=item $term->destroy
		564
		565	Destroy the terminal object (close the window, free resources etc.).
424		566
425	=item $value = $term->resource ($name[, $newval])	567	=item $value = $term->resource ($name[, $newval])
426		568
427	Returns the current resource value associated with a given name and	569	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>	570	optionally sets a new value. Setting values is most useful in the C<init>
…		…
446	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	588	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447	borderLess color cursorBlink cursorUnderline cutchars delete_key	589	borderLess color cursorBlink cursorUnderline cutchars delete_key
448	display_name embed ext_bwidth fade font geometry hold iconName	590	display_name embed ext_bwidth fade font geometry hold iconName
449	imFont imLocale inputMethod insecure int_bwidth intensityStyles	591	imFont imLocale inputMethod insecure int_bwidth intensityStyles
450	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	592	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
451	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	593	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
452	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	594	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
453	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	595	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
454	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	596	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
455	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	597	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
456	shade term_name title transparent transparent_all tripleclickwords	598	shade term_name title transparent transparent_all tripleclickwords
…		…
459	=cut	601	=cut
460		602
461	sub urxvt::term::resource($$;$) {	603	sub urxvt::term::resource($$;$) {
462	my ($self, $name) = (shift, shift);	604	my ($self, $name) = (shift, shift);
463	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	605	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
464	goto &urxvt::term::_resource;	606	&urxvt::term::_resource
465	}	607	}
		608
		609	=item $rend = $term->rstyle ([$new_rstyle])
		610
		611	Return and optionally change the current rendition. Text that is output by
		612	the terminal application will use this style.
		613
		614	=item ($row, $col) = $term->screen_cur ([$row, $col])
		615
		616	Return the current coordinates of the text cursor position and optionally
		617	set it (which is usually bad as applications don't expect that).
466		618
467	=item ($row, $col) = $term->selection_mark ([$row, $col])	619	=item ($row, $col) = $term->selection_mark ([$row, $col])
468		620
469	=item ($row, $col) = $term->selection_beg ([$row, $col])	621	=item ($row, $col) = $term->selection_beg ([$row, $col])
470		622
…		…
485	#=item $term->overlay ($x, $y, $text)	637	#=item $term->overlay ($x, $y, $text)
486	#	638	#
487	#Create a simple multi-line overlay box. See the next method for details.	639	#Create a simple multi-line overlay box. See the next method for details.
488	#	640	#
489	#=cut	641	#=cut
490		642	#
491	sub urxvt::term::scr_overlay {	643	#sub urxvt::term::scr_overlay {
492	die;
493	my ($self, $x, $y, $text) = @_;	644	# my ($self, $x, $y, $text) = @_;
494		645	#
495	my @lines = split /\n/, $text;	646	# my @lines = split /\n/, $text;
496		647	#
497	my $w = 0;	648	# my $w = 0;
498	for (map $self->strwidth ($_), @lines) {	649	# for (map $self->strwidth ($_), @lines) {
499	$w = $_ if $w < $_;	650	# $w = $_ if $w < $_;
500	}	651	# }
501		652	#
502	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	653	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
503	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	654	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
504	}	655	#}
505		656
506	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	657	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
507		658
508	Create a new (empty) overlay at the given position with the given	659	Create a new (empty) overlay at the given position with the given
509	width/height. C<$rstyle> defines the initial rendition style	660	width/height. C<$rstyle> defines the initial rendition style
…		…
536		687
537	If hidden, display the overlay again.	688	If hidden, display the overlay again.
538		689
539	=back	690	=back
540		691
		692	=item $popup = $term->popup ($event)
		693
		694	Creates a new C<urxvt::popup> object that implements a popup menu. The
		695	C<$event> I<must> be the event causing the menu to pop up (a button event,
		696	currently).
		697
		698	=cut
		699
		700	sub urxvt::term::popup {
		701	my ($self, $event) = @_;
		702
		703	$self->grab ($event->{time}, 1)
		704	or return;
		705
		706	my $popup = bless {
		707	term => $self,
		708	event => $event,
		709	}, urxvt::popup::;
		710
		711	Scalar::Util::weaken $popup->{term};
		712
		713	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		714	Scalar::Util::weaken $self->{_destroy}{$popup};
		715
		716	$popup
		717	}
		718
541	=item $cellwidth = $term->strwidth $string	719	=item $cellwidth = $term->strwidth ($string)
542		720
543	Returns the number of screen-cells this string would need. Correctly	721	Returns the number of screen-cells this string would need. Correctly
544	accounts for wide and combining characters.	722	accounts for wide and combining characters.
545		723
546	=item $octets = $term->locale_encode $string	724	=item $octets = $term->locale_encode ($string)
547		725
548	Convert the given text string into the corresponding locale encoding.	726	Convert the given text string into the corresponding locale encoding.
549		727
550	=item $string = $term->locale_decode $octets	728	=item $string = $term->locale_decode ($octets)
551		729
552	Convert the given locale-encoded octets into a perl string.	730	Convert the given locale-encoded octets into a perl string.
		731
		732	=item $term->scr_add_lines ($string)
		733
		734	Write the given text string to the screen, as if output by the application
		735	running inside the terminal. It may not contain command sequences (escape
		736	codes), but is free to use line feeds, carriage returns and tabs. The
		737	string is a normal text string, not in locale-dependent encoding.
		738
		739	Normally its not a good idea to use this function, as programs might be
		740	confused by changes in cursor position or scrolling. Its useful inside a
		741	C<on_add_lines> hook, though.
		742
		743	=item $term->cmd_parse ($octets)
		744
		745	Similar to C<scr_add_lines>, but the argument must be in the
		746	locale-specific encoding of the terminal and can contain command sequences
		747	(escape codes) that will be interpreted.
553		748
554	=item $term->tt_write ($octets)	749	=item $term->tt_write ($octets)
555		750
556	Write the octets given in C<$data> to the tty (i.e. as program input). To	751	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	752	pass characters instead of octets, you should convert your strings first
558	to the locale-specific encoding using C<< $term->locale_encode >>.	753	to the locale-specific encoding using C<< $term->locale_encode >>.
559		754
		755	=item $windowid = $term->parent
		756
		757	Return the window id of the toplevel window.
		758
		759	=item $windowid = $term->vt
		760
		761	Return the window id of the terminal window.
		762
		763	=item $window_width = $term->width
		764
		765	=item $window_height = $term->height
		766
		767	=item $font_width = $term->fwidth
		768
		769	=item $font_height = $term->fheight
		770
		771	=item $font_ascent = $term->fbase
		772
560	=item $nrow = $term->nrow	773	=item $terminal_rows = $term->nrow
561		774
562	=item $ncol = $term->ncol	775	=item $terminal_columns = $term->ncol
563		776
564	Return the number of rows/columns of the terminal window (i.e. as	777	=item $has_focus = $term->focus
565	specified by C<-geometry>, excluding any scrollback).
566		778
567	=item $nsaved = $term->nsaved	779	=item $is_mapped = $term->mapped
568		780
569	Returns the number of lines in the scrollback buffer.	781	=item $max_scrollback = $term->saveLines
		782
		783	=item $nrow_plus_saveLines = $term->total_rows
		784
		785	=item $lines_in_scrollback = $term->nsaved
		786
		787	Return various integers describing terminal characteristics.
		788
		789	=item $modifiermask = $term->ModLevel3Mask
		790
		791	=item $modifiermask = $term->ModMetaMask
		792
		793	=item $modifiermask = $term->ModNumLockMask
		794
		795	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		796	AltGr), the meta key (often Alt) and the num lock key, if applicable.
570		797
571	=item $view_start = $term->view_start ([$newvalue])	798	=item $view_start = $term->view_start ([$newvalue])
572		799
573	Returns the negative row number of the topmost line. Minimum value is	800	Returns the negative row number of the topmost line. Minimum value is
574	C<0>, which displays the normal terminal contents. Larger values scroll	801	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	864	about the logical line that row C<$row_number> is part of. It supports the
638	following methods:	865	following methods:
639		866
640	=over 4	867	=over 4
641		868
642	=item $text = $line->t	869	=item $text = $line->t ([$new_text])
643		870
644	Returns the full text of the line, similar to C<ROW_t>	871	Returns or replaces the full text of the line, similar to C<ROW_t>
645		872
646	=item $rend = $line->r	873	=item $rend = $line->r ([$new_rend])
647		874
648	Returns the full rendition array of the line, similar to C<ROW_r>	875	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
649		876
650	=item $length = $line->l	877	=item $length = $line->l
651		878
652	Returns the length of the line in cells, similar to C<ROW_l>.	879	Returns the length of the line in cells, similar to C<ROW_l>.
653		880
…		…
682		909
683	bless {	910	bless {
684	term => $self,	911	term => $self,
685	beg => $beg,	912	beg => $beg,
686	end => $end,	913	end => $end,
		914	ncol => $self->ncol,
687	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	915	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
688	}, urxvt::line::	916	}, urxvt::line::
689	}	917	}
690		918
691	sub urxvt::line::t {	919	sub urxvt::line::t {
692	my ($self) = @_;	920	my ($self) = @_;
693		921
		922	if (@_ > 1)
		923	{
		924	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		925	for $self->{beg} .. $self->{end};
		926	}
		927
		928	defined wantarray &&
694	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	929	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
695	0, $self->{len}	930	0, $self->{len}
696	}	931	}
697		932
698	sub urxvt::line::r {	933	sub urxvt::line::r {
699	my ($self) = @_;	934	my ($self) = @_;
700		935
		936	if (@_ > 1)
		937	{
		938	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		939	for $self->{beg} .. $self->{end};
		940	}
		941
		942	if (defined wantarray) {
701	my $rend = [	943	my $rend = [
702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	944	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
703	];	945	];
704	$#$rend = $self->{len} - 1;	946	$#$rend = $self->{len} - 1;
705	$rend	947	return $rend;
		948	}
		949
		950	()
706	}	951	}
707		952
708	sub urxvt::line::beg { $_[0]{beg} }	953	sub urxvt::line::beg { $_[0]{beg} }
709	sub urxvt::line::end { $_[0]{end} }	954	sub urxvt::line::end { $_[0]{end} }
710	sub urxvt::line::l { $_[0]{len} }	955	sub urxvt::line::l { $_[0]{len} }
711		956
712	sub urxvt::line::offset_of {	957	sub urxvt::line::offset_of {
713	my ($self, $row, $col) = @_;	958	my ($self, $row, $col) = @_;
714		959
715	($row - $self->{beg}) * $self->{term}->ncol + $col	960	($row - $self->{beg}) * $self->{ncol} + $col
716	}	961	}
717		962
718	sub urxvt::line::coord_of {	963	sub urxvt::line::coord_of {
719	my ($self, $offset) = @_;	964	my ($self, $offset) = @_;
720		965
721	use integer;	966	use integer;
722		967
723	(	968	(
724	$offset / $self->{term}->ncol + $self->{beg},	969	$offset / $self->{ncol} + $self->{beg},
725	$offset % $self->{term}->ncol	970	$offset % $self->{ncol}
726	)	971	)
727	}	972	}
728		973
729	=item ($row, $col) = $line->coord_of ($offset)	974	=item ($row, $col) = $line->coord_of ($offset)
730	=item $text = $term->special_encode $string	975	=item $text = $term->special_encode $string
…		…
737		982
738	Converts rxvt-unicodes text reprsentation into a perl string. See	983	Converts rxvt-unicodes text reprsentation into a perl string. See
739	C<< $term->ROW_t >> for details.	984	C<< $term->ROW_t >> for details.
740		985
741	=back	986	=back
		987
		988	=head2 The C<urxvt::popup> Class
		989
		990	=over 4
		991
		992	=cut
		993
		994	package urxvt::popup;
		995
		996	sub add_item {
		997	my ($self, $item) = @_;
		998
		999	push @{ $self->{item} }, $item;
		1000	}
		1001
		1002	sub add_button {
		1003	my ($self, $text, $cb) = @_;
		1004
		1005	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb });
		1006	}
		1007
		1008	sub show {
		1009	my ($self) = @_;
		1010
		1011	local $urxvt::popup::self = $self;
		1012
		1013	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1014	"--transient-for" => $self->{term}->parent,
		1015	"-pe" => "urxvt-popup")
		1016	or die "unable to create popup window\n";
		1017	}
		1018
		1019	sub DESTROY {
		1020	my ($self) = @_;
		1021
		1022	$self->{term}->ungrab;
		1023	}
742		1024
743	=head2 The C<urxvt::timer> Class	1025	=head2 The C<urxvt::timer> Class
744		1026
745	This class implements timer watchers/events. Time is represented as a	1027	This class implements timer watchers/events. Time is represented as a
746	fractional number of seconds since the epoch. Example:	1028	fractional number of seconds since the epoch. Example:
…		…
848	This variable controls the verbosity level of the perl extension. Higher	1130	This variable controls the verbosity level of the perl extension. Higher
849	numbers indicate more verbose output.	1131	numbers indicate more verbose output.
850		1132
851	=over 4	1133	=over 4
852		1134
853	=item 0 - only fatal messages	1135	=item =0 - only fatal messages
854		1136
855	=item 3 - script loading and management	1137	=item =3 - script loading and management
856		1138
857	=item 10 - all events received	1139	=item =10 - all events received
858		1140
859	=back	1141	=back
860		1142
861	=head1 AUTHOR	1143	=head1 AUTHOR
862		1144

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.47 by root, Sat Jan 7 21:22:02 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.47 by root, Sat Jan 7 21:22:02 2006 UTC