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