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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC vs.
Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
…		…
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection
43		43
44	Intelligent selection. This etxension tries to be more intelligent when the user	44	Intelligent selection. This extension tries to be more intelligent when
45	extends selections (double-click).	45	the user extends selections (double-click). Right now, it tries to select
		46	urls and complete shell-quoted arguments, which is very convenient, too,
		47	if your F<ls> supports C<--quoting-style=shell>.
46		48
47	It also offers the following bindable event:	49	It also offers the following bindable event:
48		50
49	=over 4	51	=over 4
50		52
…		…
57	=back	59	=back
58		60
59	=item digital-clock	61	=item digital-clock
60		62
61	Displays a digital clock using the built-in overlay.	63	Displays a digital clock using the built-in overlay.
		64
		65	=item mark-urls
		66
		67	Uses per-line display filtering (C<on_line_update>) to underline urls.
		68
		69	=item block-graphics-to-ascii
		70
		71	A not very useful example of filtering all text output to the terminal,
		72	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		73	similar-looking ascii character.
62		74
63	=item example-refresh-hooks	75	=item example-refresh-hooks
64		76
65	Displays a very simple digital clock in the upper right corner of the	77	Displays a very simple digital clock in the upper right corner of the
66	window. Illustrates overwriting the refresh callbacks to create your own	78	window. Illustrates overwriting the refresh callbacks to create your own
…		…
71	=head2 General API Considerations	83	=head2 General API Considerations
72		84
73	All objects (such as terminals, time watchers etc.) are typical	85	All objects (such as terminals, time watchers etc.) are typical
74	reference-to-hash objects. The hash can be used to store anything you	86	reference-to-hash objects. The hash can be used to store anything you
75	like. All members starting with an underscore (such as C<_ptr> or	87	like. All members starting with an underscore (such as C<_ptr> or
76	C<_hook>) are reserved for internal uses and must not be accessed or	88	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
77	modified).	89	modified).
78		90
79	When objects are destroyed on the C++ side, the perl object hashes are	91	When objects are destroyed on the C++ side, the perl object hashes are
80	emptied, so its best to store related objects such as time watchers and	92	emptied, so its best to store related objects such as time watchers and
81	the like inside the terminal object so they get destroyed as soon as the	93	the like inside the terminal object so they get destroyed as soon as the
82	terminal is destroyed.	94	terminal is destroyed.
83		95
		96	Argument names also often indicate the type of a parameter. Here are some
		97	hints on what they mean:
		98
		99	=over 4
		100
		101	=item $text
		102
		103	Rxvt-unicodes special way of encoding text, where one "unicode" character
		104	always represents one screen cell. See L<row_t> for a discussion of this format.
		105
		106	=item $string
		107
		108	A perl text string, with an emphasis on I<text>. It can store all unicode
		109	characters and is to be distinguished with text encoded in a specific
		110	encoding (often locale-specific) and binary data.
		111
		112	=item $octets
		113
		114	Either binary data or - more common - a text string encoded in a
		115	locale-specific way.
		116
		117	=back
		118
84	=head2 Hooks	119	=head2 Hooks
85		120
86	The following subroutines can be declared in loaded scripts, and will be called	121	The following subroutines can be declared in extension files, and will be
87	whenever the relevant event happens.	122	called whenever the relevant event happens.
		123
		124	The first argument passed to them is an object private to each terminal
		125	and extension package. You can call all C<urxvt::term> methods on it, but
		126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		127	object that is shared between all packages is stored in the C<term>
		128	member. It is, however, blessed intot he package of the extension script,
		129	so for all practical purposes you can treat an extension script as a class.
88		130
89	All of them must return a boolean value. If it is true, then the event	131	All of them must return a boolean value. If it is true, then the event
90	counts as being I<consumed>, and the invocation of other hooks is skipped,	132	counts as being I<consumed>, and the invocation of other hooks is skipped,
91	and the relevant action might not be carried out by the C++ code.	133	and the relevant action might not be carried out by the C++ code.
92		134
…		…
95	=over 4	137	=over 4
96		138
97	=item on_init $term	139	=item on_init $term
98		140
99	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
100	windows are created or the command gets run.	142	windows are created or the command gets run. Most methods are unsafe to
		143	call or deliver senseless data, as terminal size and other characteristics
		144	have not yet been determined. You can safely query and change resources,
		145	though.
101		146
102	=item on_reset $term	147	=item on_reset $term
103		148
104	Called after the screen is "reset" for any reason, such as resizing or	149	Called after the screen is "reset" for any reason, such as resizing or
105	control sequences. Here is where you can react on changes to size-related	150	control sequences. Here is where you can react on changes to size-related
…		…
134	should extend the selection itelf and return true to suppress the built-in	179	should extend the selection itelf and return true to suppress the built-in
135	processing.	180	processing.
136		181
137	See the F<selection> example extension.	182	See the F<selection> example extension.
138		183
139	=item on_focus_in $term
140
141	Called whenever the window gets the keyboard focus, before urxvt does
142	focus in processing.
143
144	=item on_focus_out $term
145
146	Called wheneever the window loses keyboard focus, before urxvt does focus
147	out processing.
148
149	=item on_view_change $term, $offset	184	=item on_view_change $term, $offset
150		185
151	Called whenever the view offset changes, i..e the user or program	186	Called whenever the view offset changes, i..e the user or program
152	scrolls. Offset C<0> means display the normal terminal, positive values	187	scrolls. Offset C<0> means display the normal terminal, positive values
153	show this many lines of scrollback.	188	show this many lines of scrollback.
…		…
163	number of lines that will be in the scrollback buffer.	198	number of lines that will be in the scrollback buffer.
164		199
165	=item on_tty_activity $term NYI	200	=item on_tty_activity $term NYI
166		201
167	Called whenever the program(s) running in the urxvt window send output.	202	Called whenever the program(s) running in the urxvt window send output.
		203
		204	=item on_osc_seq $term, $string
		205
		206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		207	operating system command) is processed. Cursor position and other state
		208	information is up-to-date when this happens. For interoperability, the
		209	string should start with the extension name and a colon, to distinguish
		210	it from commands for other extensions, and this might be enforced in the
		211	future.
		212
		213	Be careful not ever to trust (in a security sense) the data you receive,
		214	as its source can not easily be controleld (e-mail content, messages from
		215	other users on the same system etc.).
		216
		217	=item on_add_lines $term, $string
		218
		219	Called whenever text is about to be output, with the text as argument. You
		220	can filter/change and output the text yourself by returning a true value
		221	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		222	might be very slow, however, as your hook is called for B<all> text being
		223	output.
		224
		225	=item on_line_update $term, $row
		226
		227	Called whenever a line was updated or changed. Can be used to filter
		228	screen output (e.g. underline urls or other useless stuff). Only lines
		229	that are being shown will be filtered, and, due to performance reasons,
		230	not always immediately.
		231
		232	The row number is always the topmost row of the line if the line spans
		233	multiple rows.
		234
		235	Please note that, if you change the line, then the hook might get called
		236	later with the already-modified line (e.g. if unrelated parts change), so
		237	you cannot just toggle rendition bits, but only set them.
168		238
169	=item on_refresh_begin $term	239	=item on_refresh_begin $term
170		240
171	Called just before the screen gets redrawn. Can be used for overlay	241	Called just before the screen gets redrawn. Can be used for overlay
172	or similar effects by modify terminal contents in refresh_begin, and	242	or similar effects by modify terminal contents in refresh_begin, and
…		…
181		251
182	Called whenever the user presses a key combination that has a	252	Called whenever the user presses a key combination that has a
183	C<perl:string> action bound to it (see description of the B<keysym>	253	C<perl:string> action bound to it (see description of the B<keysym>
184	resource in the @@RXVT_NAME@@(1) manpage).	254	resource in the @@RXVT_NAME@@(1) manpage).
185		255
		256	=item on_focus_in $term
		257
		258	Called whenever the window gets the keyboard focus, before rxvt-unicode
		259	does focus in processing.
		260
		261	=item on_focus_out $term
		262
		263	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		264	focus out processing.
		265
		266	=item on_key_press $term, $event, $octets
		267
		268	=item on_key_release $term, $event
		269
		270	=item on_button_press $term, $event
		271
		272	=item on_button_release $term, $event
		273
		274	=item on_motion_notify $term, $event
		275
		276	=item on_map_notify $term, $event
		277
		278	=item on_unmap_notify $term, $event
		279
		280	Called whenever the corresponding X event is received for the terminal If
		281	the hook returns true, then the even will be ignored by rxvt-unicode.
		282
		283	The event is a hash with most values as named by Xlib (see the XEvent
		284	manpage), with the additional members C<row> and C<col>, which are the row
		285	and column under the mouse cursor.
		286
		287	C<on_key_press> additionally receives the string rxvt-unicode would
		288	output, if any, in locale-specific encoding.
		289
		290	subwindow.
		291
		292	=back
		293
		294	=head2 Variables in the C<urxvt> Package
		295
		296	=over 4
		297
		298	=item $urxvt::TERM
		299
		300	The current terminal. This variable stores the current C<urxvt::term>
		301	object, whenever a callback/hook is executing.
		302
186	=back	303	=back
187		304
188	=head2 Functions in the C<urxvt> Package	305	=head2 Functions in the C<urxvt> Package
189		306
190	=over 4	307	=over 4
		308
		309	=item $term = new urxvt [arg...]
		310
		311	Creates a new terminal, very similar as if you had started it with
		312	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		313	if the new instance couldn't be created. Returns C<undef> if the new
		314	instance didn't initialise perl, and the terminal object otherwise. The
		315	C<init> and C<start> hooks will be called during the call.
191		316
192	=item urxvt::fatal $errormessage	317	=item urxvt::fatal $errormessage
193		318
194	Fatally aborts execution with the given error message. Avoid at all	319	Fatally aborts execution with the given error message. Avoid at all
195	costs! The only time this is acceptable is when the terminal process	320	costs! The only time this is acceptable is when the terminal process
…		…
205	correct place, e.g. on stderr of the connecting urxvtc client.	330	correct place, e.g. on stderr of the connecting urxvtc client.
206		331
207	=item $time = urxvt::NOW	332	=item $time = urxvt::NOW
208		333
209	Returns the "current time" (as per the event loop).	334	Returns the "current time" (as per the event loop).
		335
		336	=item urxvt::CurrentTime
		337
		338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		340	Button4Mask, Button5Mask, AnyModifier
		341
		342	Various constants for use in X events.
210		343
211	=back	344	=back
212		345
213	=head2 RENDITION	346	=head2 RENDITION
214		347
…		…
264		397
265	=cut	398	=cut
266		399
267	package urxvt;	400	package urxvt;
268		401
		402	use utf8;
269	use strict;	403	use strict;
		404	use Scalar::Util ();
		405	use List::Util ();
270		406
271	our $term;	407	our $TERM;
272	our @HOOKNAME;	408	our @HOOKNAME;
273	our $LIBDIR;	409	our $LIBDIR;
274		410
275	BEGIN {	411	BEGIN {
276	urxvt->bootstrap;	412	urxvt->bootstrap;
…		…
301	my $name = $HOOKNAME[$htype];	437	my $name = $HOOKNAME[$htype];
302		438
303	my $ref = $pkg->can ("on_" . lc $name)	439	my $ref = $pkg->can ("on_" . lc $name)
304	or next;	440	or next;
305		441
306	$term->{_hook}[$htype]{$ref*1} = $ref;	442	$TERM->{_hook}[$htype]{$pkg} = $ref;
307	$hook_count[$htype]++	443	$hook_count[$htype]++
308	or set_should_invoke $htype, 1;	444	or set_should_invoke $htype, 1;
309	}	445	}
310	}	446	}
311		447
312	my $script_pkg = "script0000";	448	my $extension_pkg = "extension0000";
313	my %script_pkg;	449	my %extension_pkg;
314		450
315	# load a single script into its own package, once only	451	# load a single script into its own package, once only
316	sub script_package($) {	452	sub extension_package($) {
317	my ($path) = @_;	453	my ($path) = @_;
318		454
319	$script_pkg{$path} \|\|= do {	455	$extension_pkg{$path} \|\|= do {
320	my $pkg = "urxvt::" . ($script_pkg++);	456	my $pkg = "urxvt::" . ($extension_pkg++);
321		457
322	verbose 3, "loading script '$path' into package '$pkg'";	458	verbose 3, "loading extension '$path' into package '$pkg'";
323		459
324	open my $fh, "<:raw", $path	460	open my $fh, "<:raw", $path
325	or die "$path: $!";	461	or die "$path: $!";
326		462
327	my $source = "package $pkg; use strict; use utf8;\n"	463	my $source = "package $pkg; use strict; use utf8;\n"
		464	. "use base urxvt::term::proxy::;\n"
328	. "#line 1 \"$path\"\n{\n"	465	. "#line 1 \"$path\"\n{\n"
329	. (do { local $/; <$fh> })	466	. (do { local $/; <$fh> })
330	. "\n};\n1";	467	. "\n};\n1";
331		468
332	eval $source or die "$path: $@";	469	eval $source or die "$path: $@";
333		470
334	$pkg	471	$pkg
335	}	472	}
336	}	473	}
337		474
		475	our $retval; # return value for urxvt
		476
338	# called by the rxvt core	477	# called by the rxvt core
339	sub invoke {	478	sub invoke {
340	local $term = shift;	479	local $TERM = shift;
341	my $htype = shift;	480	my $htype = shift;
342		481
343	if ($htype == 0) { # INIT	482	if ($htype == 0) { # INIT
344	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	483	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
345		484
346	for my $ext (split /:/, $term->resource ("perl_ext")) {	485	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
347	my @files = grep -f $_, map "$_/$ext", @dirs;	486	my @files = grep -f $_, map "$_/$ext", @dirs;
348		487
349	if (@files) {	488	if (@files) {
350	register_package script_package $files[0];	489	register_package extension_package $files[0];
351	} else {	490	} else {
352	warn "perl extension '$ext' not found in perl library search path\n";	491	warn "perl extension '$ext' not found in perl library search path\n";
353	}	492	}
354	}	493	}
		494	}
355		495
		496	$retval = undef;
		497
		498	if (my $cb = $TERM->{_hook}[$htype]) {
		499	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		500	if $verbosity >= 10;
		501
		502	keys %$cb;
		503
		504	while (my ($pkg, $cb) = each %$cb) {
		505	eval {
		506	$retval = $cb->(
		507	$TERM->{_pkg}{$pkg} \|\|= do {
		508	my $proxy = bless { }, $pkg;
		509	Scalar::Util::weaken ($proxy->{term} = $TERM);
		510	$proxy
		511	},
		512	@_,
		513	) and last;
		514	};
		515	warn $@ if $@;#d#
		516	}
		517	}
		518
356	} elsif ($htype == 1) { # DESTROY	519	if ($htype == 1) { # DESTROY
		520	# remove hooks if unused
357	if (my $hook = $term->{_hook}) {	521	if (my $hook = $TERM->{_hook}) {
358	for my $htype (0..$#$hook) {	522	for my $htype (0..$#$hook) {
359	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	523	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
360	or set_should_invoke $htype, 0;	524	or set_should_invoke $htype, 0;
361	}	525	}
362	}	526	}
		527
		528	# clear package objects
		529	%$_ = () for values %{ $TERM->{_pkg} };
		530
		531	# clear package
		532	%$TERM = ();
363	}	533	}
364		534
365	my $cb = $term->{_hook}[$htype]	535	$retval
366	or return;	536	}
367		537
368	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	538	sub urxvt::term::proxy::AUTOLOAD {
369	if $verbosity >= 10;	539	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		540	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
370		541
371	while (my ($k, $v) = each %$cb) {	542	eval qq{
372	return 1 if $v->($term, @_);	543	sub $urxvt::term::proxy::AUTOLOAD {
373	}	544	my \$proxy = shift;
		545	\$proxy->{term}->$1 (\@_)
		546	}
		547	1
		548	} or die "FATAL: unable to compile method forwarder: $@";
374		549
375	0	550	goto &$urxvt::term::proxy::AUTOLOAD;
		551	}
		552
		553	sub urxvt::destroy_hook::DESTROY {
		554	${$_[0]}->();
		555	}
		556
		557	sub urxvt::destroy_hook(&) {
		558	bless \shift, urxvt::destroy_hook::
376	}	559	}
377		560
378	=head2 The C<urxvt::term> Class	561	=head2 The C<urxvt::term> Class
379		562
380	=over 4	563	=over 4
		564
		565	=item $term->destroy
		566
		567	Destroy the terminal object (close the window, free resources etc.).
381		568
382	=item $value = $term->resource ($name[, $newval])	569	=item $value = $term->resource ($name[, $newval])
383		570
384	Returns the current resource value associated with a given name and	571	Returns the current resource value associated with a given name and
385	optionally sets a new value. Setting values is most useful in the C<init>	572	optionally sets a new value. Setting values is most useful in the C<init>
…		…
403	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	590	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
404	borderLess color cursorBlink cursorUnderline cutchars delete_key	591	borderLess color cursorBlink cursorUnderline cutchars delete_key
405	display_name embed ext_bwidth fade font geometry hold iconName	592	display_name embed ext_bwidth fade font geometry hold iconName
406	imFont imLocale inputMethod insecure int_bwidth intensityStyles	593	imFont imLocale inputMethod insecure int_bwidth intensityStyles
407	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	594	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
408	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	595	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
409	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	596	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
410	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	597	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
411	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	598	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
412	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	599	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
413	shade term_name title transparent transparent_all tripleclickwords	600	shade term_name title transparent transparent_all tripleclickwords
…		…
416	=cut	603	=cut
417		604
418	sub urxvt::term::resource($$;$) {	605	sub urxvt::term::resource($$;$) {
419	my ($self, $name) = (shift, shift);	606	my ($self, $name) = (shift, shift);
420	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	607	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
421	goto &urxvt::term::_resource;	608	&urxvt::term::_resource
422	}	609	}
		610
		611	=item $rend = $term->rstyle ([$new_rstyle])
		612
		613	Return and optionally change the current rendition. Text that is output by
		614	the terminal application will use this style.
		615
		616	=item ($row, $col) = $term->screen_cur ([$row, $col])
		617
		618	Return the current coordinates of the text cursor position and optionally
		619	set it (which is usually bad as applications don't expect that).
423		620
424	=item ($row, $col) = $term->selection_mark ([$row, $col])	621	=item ($row, $col) = $term->selection_mark ([$row, $col])
425		622
426	=item ($row, $col) = $term->selection_beg ([$row, $col])	623	=item ($row, $col) = $term->selection_beg ([$row, $col])
427		624
…		…
442	#=item $term->overlay ($x, $y, $text)	639	#=item $term->overlay ($x, $y, $text)
443	#	640	#
444	#Create a simple multi-line overlay box. See the next method for details.	641	#Create a simple multi-line overlay box. See the next method for details.
445	#	642	#
446	#=cut	643	#=cut
447		644	#
448	sub urxvt::term::scr_overlay {	645	#sub urxvt::term::scr_overlay {
449	die;
450	my ($self, $x, $y, $text) = @_;	646	# my ($self, $x, $y, $text) = @_;
451		647	#
452	my @lines = split /\n/, $text;	648	# my @lines = split /\n/, $text;
453		649	#
454	my $w = 0;	650	# my $w = 0;
455	for (map $self->strwidth ($_), @lines) {	651	# for (map $self->strwidth ($_), @lines) {
456	$w = $_ if $w < $_;	652	# $w = $_ if $w < $_;
457	}	653	# }
458		654	#
459	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	655	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
460	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	656	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
461	}	657	#}
462		658
463	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	659	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
464		660
465	Create a new (empty) overlay at the given position with the given	661	Create a new (empty) overlay at the given position with the given
466	width/height. C<$rstyle> defines the initial rendition style	662	width/height. C<$rstyle> defines the initial rendition style
…		…
493		689
494	If hidden, display the overlay again.	690	If hidden, display the overlay again.
495		691
496	=back	692	=back
497		693
		694	=item $popup = $term->popup ($event)
		695
		696	Creates a new C<urxvt::popup> object that implements a popup menu. The
		697	C<$event> I<must> be the event causing the menu to pop up (a button event,
		698	currently).
		699
		700	=cut
		701
		702	sub urxvt::term::popup {
		703	my ($self, $event) = @_;
		704
		705	$self->grab ($event->{time}, 1)
		706	or return;
		707
		708	my $popup = bless {
		709	term => $self,
		710	event => $event,
		711	}, urxvt::popup::;
		712
		713	Scalar::Util::weaken $popup->{term};
		714
		715	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		716	Scalar::Util::weaken $self->{_destroy}{$popup};
		717
		718	$popup
		719	}
		720
498	=item $cellwidth = $term->strwidth $string	721	=item $cellwidth = $term->strwidth ($string)
499		722
500	Returns the number of screen-cells this string would need. Correctly	723	Returns the number of screen-cells this string would need. Correctly
501	accounts for wide and combining characters.	724	accounts for wide and combining characters.
502		725
503	=item $octets = $term->locale_encode $string	726	=item $octets = $term->locale_encode ($string)
504		727
505	Convert the given text string into the corresponding locale encoding.	728	Convert the given text string into the corresponding locale encoding.
506		729
507	=item $string = $term->locale_decode $octets	730	=item $string = $term->locale_decode ($octets)
508		731
509	Convert the given locale-encoded octets into a perl string.	732	Convert the given locale-encoded octets into a perl string.
		733
		734	=item $term->scr_add_lines ($string)
		735
		736	Write the given text string to the screen, as if output by the application
		737	running inside the terminal. It may not contain command sequences (escape
		738	codes), but is free to use line feeds, carriage returns and tabs. The
		739	string is a normal text string, not in locale-dependent encoding.
		740
		741	Normally its not a good idea to use this function, as programs might be
		742	confused by changes in cursor position or scrolling. Its useful inside a
		743	C<on_add_lines> hook, though.
		744
		745	=item $term->cmd_parse ($octets)
		746
		747	Similar to C<scr_add_lines>, but the argument must be in the
		748	locale-specific encoding of the terminal and can contain command sequences
		749	(escape codes) that will be interpreted.
510		750
511	=item $term->tt_write ($octets)	751	=item $term->tt_write ($octets)
512		752
513	Write the octets given in C<$data> to the tty (i.e. as program input). To	753	Write the octets given in C<$data> to the tty (i.e. as program input). To
514	pass characters instead of octets, you should convert your strings first	754	pass characters instead of octets, you should convert your strings first
515	to the locale-specific encoding using C<< $term->locale_encode >>.	755	to the locale-specific encoding using C<< $term->locale_encode >>.
516		756
		757	=item $windowid = $term->parent
		758
		759	Return the window id of the toplevel window.
		760
		761	=item $windowid = $term->vt
		762
		763	Return the window id of the terminal window.
		764
		765	=item $window_width = $term->width
		766
		767	=item $window_height = $term->height
		768
		769	=item $font_width = $term->fwidth
		770
		771	=item $font_height = $term->fheight
		772
		773	=item $font_ascent = $term->fbase
		774
517	=item $nrow = $term->nrow	775	=item $terminal_rows = $term->nrow
518		776
519	=item $ncol = $term->ncol	777	=item $terminal_columns = $term->ncol
520		778
521	Return the number of rows/columns of the terminal window (i.e. as	779	=item $has_focus = $term->focus
522	specified by C<-geometry>, excluding any scrollback).
523		780
524	=item $nsaved = $term->nsaved	781	=item $is_mapped = $term->mapped
525		782
526	Returns the number of lines in the scrollback buffer.	783	=item $max_scrollback = $term->saveLines
		784
		785	=item $nrow_plus_saveLines = $term->total_rows
		786
		787	=item $lines_in_scrollback = $term->nsaved
		788
		789	Return various integers describing terminal characteristics.
		790
		791	=item $modifiermask = $term->ModLevel3Mask
		792
		793	=item $modifiermask = $term->ModMetaMask
		794
		795	=item $modifiermask = $term->ModNumLockMask
		796
		797	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		798	AltGr), the meta key (often Alt) and the num lock key, if applicable.
527		799
528	=item $view_start = $term->view_start ([$newvalue])	800	=item $view_start = $term->view_start ([$newvalue])
529		801
530	Returns the negative row number of the topmost line. Minimum value is	802	Returns the negative row number of the topmost line. Minimum value is
531	C<0>, which displays the normal terminal contents. Larger values scroll	803	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
542	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	814	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
543		815
544	Returns the text of the entire row with number C<$row_number>. Row C<0>	816	Returns the text of the entire row with number C<$row_number>. Row C<0>
545	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	817	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
546	terminal line. The scrollback buffer starts at line C<-1> and extends to	818	terminal line. The scrollback buffer starts at line C<-1> and extends to
547	line C<< -$term->nsaved >>.	819	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		820	is requested.
548		821
549	If C<$new_text> is specified, it will replace characters in the current	822	If C<$new_text> is specified, it will replace characters in the current
550	line, starting at column C<$start_col> (default C<0>), which is useful	823	line, starting at column C<$start_col> (default C<0>), which is useful
551	to replace only parts of a line. The font index in the rendition will	824	to replace only parts of a line. The font index in the rendition will
552	automatically be updated.	825	automatically be updated.
…		…
574		847
575	See the section on RENDITION, above.	848	See the section on RENDITION, above.
576		849
577	=item $length = $term->ROW_l ($row_number[, $new_length])	850	=item $length = $term->ROW_l ($row_number[, $new_length])
578		851
579	Returns the number of screen cells that are in use ("the line length"). If	852	Returns the number of screen cells that are in use ("the line
580	it is C<-1>, then the line is part of a multiple-row logical "line", which	853	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
581	means all characters are in use and it is continued on the next row.	854	line is joined with the following one.
582		855
		856	=item $bool = $term->is_longer ($row_number)
		857
		858	Returns true if the row is part of a multiple-row logical "line" (i.e.
		859	joined with the following row), which means all characters are in use
		860	and it is continued on the next row (and possibly a continuation of the
		861	previous row(s)).
		862
		863	=item $line = $term->line ($row_number)
		864
		865	Create and return a new C<urxvt::line> object that stores information
		866	about the logical line that row C<$row_number> is part of. It supports the
		867	following methods:
		868
		869	=over 4
		870
		871	=item $text = $line->t ([$new_text])
		872
		873	Returns or replaces the full text of the line, similar to C<ROW_t>
		874
		875	=item $rend = $line->r ([$new_rend])
		876
		877	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		878
		879	=item $length = $line->l
		880
		881	Returns the length of the line in cells, similar to C<ROW_l>.
		882
		883	=item $rownum = $line->beg
		884
		885	=item $rownum = $line->end
		886
		887	Return the row number of the first/last row of the line, respectively.
		888
		889	=item $offset = $line->offset_of ($row, $col)
		890
		891	Returns the character offset of the given row\|col pair within the logical
		892	line.
		893
		894	=item ($row, $col) = $line->coord_of ($offset)
		895
		896	Translates a string offset into terminal coordinates again.
		897
		898	=back
		899
		900	=cut
		901
		902	sub urxvt::term::line {
		903	my ($self, $row) = @_;
		904
		905	my $maxrow = $self->nrow - 1;
		906
		907	my ($beg, $end) = ($row, $row);
		908
		909	--$beg while $self->ROW_is_longer ($beg - 1);
		910	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		911
		912	bless {
		913	term => $self,
		914	beg => $beg,
		915	end => $end,
		916	ncol => $self->ncol,
		917	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		918	}, urxvt::line::
		919	}
		920
		921	sub urxvt::line::t {
		922	my ($self) = @_;
		923
		924	if (@_ > 1)
		925	{
		926	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		927	for $self->{beg} .. $self->{end};
		928	}
		929
		930	defined wantarray &&
		931	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		932	0, $self->{len}
		933	}
		934
		935	sub urxvt::line::r {
		936	my ($self) = @_;
		937
		938	if (@_ > 1)
		939	{
		940	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		941	for $self->{beg} .. $self->{end};
		942	}
		943
		944	if (defined wantarray) {
		945	my $rend = [
		946	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		947	];
		948	$#$rend = $self->{len} - 1;
		949	return $rend;
		950	}
		951
		952	()
		953	}
		954
		955	sub urxvt::line::beg { $_[0]{beg} }
		956	sub urxvt::line::end { $_[0]{end} }
		957	sub urxvt::line::l { $_[0]{len} }
		958
		959	sub urxvt::line::offset_of {
		960	my ($self, $row, $col) = @_;
		961
		962	($row - $self->{beg}) * $self->{ncol} + $col
		963	}
		964
		965	sub urxvt::line::coord_of {
		966	my ($self, $offset) = @_;
		967
		968	use integer;
		969
		970	(
		971	$offset / $self->{ncol} + $self->{beg},
		972	$offset % $self->{ncol}
		973	)
		974	}
		975
		976	=item ($row, $col) = $line->coord_of ($offset)
583	=item $text = $term->special_encode $string	977	=item $text = $term->special_encode $string
584		978
585	Converts a perl string into the special encoding used by rxvt-unicode,	979	Converts a perl string into the special encoding used by rxvt-unicode,
586	where one character corresponds to one screen cell. See	980	where one character corresponds to one screen cell. See
587	C<< $term->ROW_t >> for details.	981	C<< $term->ROW_t >> for details.
…		…
590		984
591	Converts rxvt-unicodes text reprsentation into a perl string. See	985	Converts rxvt-unicodes text reprsentation into a perl string. See
592	C<< $term->ROW_t >> for details.	986	C<< $term->ROW_t >> for details.
593		987
594	=back	988	=back
		989
		990	=head2 The C<urxvt::popup> Class
		991
		992	=over 4
		993
		994	=cut
		995
		996	package urxvt::popup;
		997
		998	sub add_item {
		999	my ($self, $item) = @_;
		1000
		1001	push @{ $self->{item} }, $item;
		1002	}
		1003
		1004	sub add_button {
		1005	my ($self, $text, $cb) = @_;
		1006
		1007	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,
		1008	render => sub { $_[0]{text} },
		1009	});
		1010	}
		1011
		1012	sub add_toggle {
		1013	my ($self, $text, $cb, $value) = @_;
		1014
		1015	$self->add_item ({ type => "button", text => " $text", value => $value,
		1016	render => sub { ($_[0]{value} ? "✔" : " ") . substr $_[0]{text}, 1 },
		1017	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1018	});
		1019	}
		1020
		1021	sub show {
		1022	my ($self) = @_;
		1023
		1024	local $urxvt::popup::self = $self;
		1025
		1026	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1027	"--transient-for" => $self->{term}->parent,
		1028	"-pe" => "urxvt-popup")
		1029	or die "unable to create popup window\n";
		1030	}
		1031
		1032	sub DESTROY {
		1033	my ($self) = @_;
		1034
		1035	$self->{term}->ungrab;
		1036	}
595		1037
596	=head2 The C<urxvt::timer> Class	1038	=head2 The C<urxvt::timer> Class
597		1039
598	This class implements timer watchers/events. Time is represented as a	1040	This class implements timer watchers/events. Time is represented as a
599	fractional number of seconds since the epoch. Example:	1041	fractional number of seconds since the epoch. Example:
…		…
701	This variable controls the verbosity level of the perl extension. Higher	1143	This variable controls the verbosity level of the perl extension. Higher
702	numbers indicate more verbose output.	1144	numbers indicate more verbose output.
703		1145
704	=over 4	1146	=over 4
705		1147
706	=item 0 - only fatal messages	1148	=item =0 - only fatal messages
707		1149
708	=item 3 - script loading and management	1150	=item =3 - script loading and management
709		1151
710	=item 10 - all events received	1152	=item =10 - all events received
711		1153
712	=back	1154	=back
713		1155
714	=head1 AUTHOR	1156	=head1 AUTHOR
715		1157

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC vs. Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC vs.
Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC