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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.18 by root, Tue Jan 3 02:01:27 2006 UTC vs.
Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC

…		…
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection
43		43
44	Miscellaneous selection modifications.	44	Intelligent selection. This extension tries to be more intelligent when
		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>.
		48
		49	It also offers the following bindable event:
45		50
46	=over 4	51	=over 4
47		52
48	=item rot13	53	=item rot13
49		54
…		…
52	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
53		58
54	=back	59	=back
55		60
56	=item digital-clock	61	=item digital-clock
		62
		63	Displays a digital clock using the built-in overlay.
		64
		65	=item mark-urls
		66
		67	Uses per-line filtering (C<on_line_update>) to underline urls.
		68
		69	=item example-refresh-hooks
57		70
58	Displays a very simple digital clock in the upper right corner of the	71	Displays a very simple digital clock in the upper right corner of the
59	window. Illustrates overwriting the refresh callbacks to create your own	72	window. Illustrates overwriting the refresh callbacks to create your own
60	overlays or changes.	73	overlays or changes.
61		74
62	=item simple-overlay-clock	75	=item example-filter-input
63		76
64	Displays a digital clock using the built-in overlay (colourful, useless).	77	A not very useful example of filtering all text output to the terminal, by
		78	underlining all urls that matches a certain regex (i.e. some urls :). It
		79	is not very useful because urls that are output in multiple steps (e.g.
		80	when typing them) do not get marked.
65		81
66	=back	82	=back
67		83
68	=head2 General API Considerations	84	=head2 General API Considerations
69		85
70	All objects (such as terminals, time watchers etc.) are typical	86	All objects (such as terminals, time watchers etc.) are typical
71	reference-to-hash objects. The hash can be used to store anything you	87	reference-to-hash objects. The hash can be used to store anything you
72	like. All members starting with an underscore (such as C<_ptr> or	88	like. All members starting with an underscore (such as C<_ptr> or
73	C<_hook>) are reserved for internal uses and must not be accessed or	89	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
74	modified).	90	modified).
75		91
76	When objects are destroyed on the C++ side, the perl object hashes are	92	When objects are destroyed on the C++ side, the perl object hashes are
77	emptied, so its best to store related objects such as time watchers and	93	emptied, so its best to store related objects such as time watchers and
78	the like inside the terminal object so they get destroyed as soon as the	94	the like inside the terminal object so they get destroyed as soon as the
79	terminal is destroyed.	95	terminal is destroyed.
80		96
		97	Argument names also often indicate the type of a parameter. Here are some
		98	hints on what they mean:
		99
		100	=over 4
		101
		102	=item $text
		103
		104	Rxvt-unicodes special way of encoding text, where one "unicode" character
		105	always represents one screen cell. See L<row_t> for a discussion of this format.
		106
		107	=item $string
		108
		109	A perl text string, with an emphasis on I<text>. It can store all unicode
		110	characters and is to be distinguished with text encoded in a specific
		111	encoding (often locale-specific) and binary data.
		112
		113	=item $octets
		114
		115	Either binary data or - more common - a text string encoded in a
		116	locale-specific way.
		117
		118	=back
		119
81	=head2 Hooks	120	=head2 Hooks
82		121
83	The following subroutines can be declared in loaded scripts, and will be called	122	The following subroutines can be declared in loaded scripts, and will be
84	whenever the relevant event happens.	123	called whenever the relevant event happens.
		124
		125	The first argument passed to them is an object private to each terminal
		126	and extension package. You can call all C<urxvt::term> methods on it, but
		127	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		128	object that is shared between all packages is stored in the C<term>
		129	member.
85		130
86	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
87	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,
88	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.
89		134
…		…
92	=over 4	137	=over 4
93		138
94	=item on_init $term	139	=item on_init $term
95		140
96	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
97	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.
98		146
99	=item on_reset $term	147	=item on_reset $term
100		148
101	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
102	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
…		…
122	requested from the server. The selection text can be queried and changed	170	requested from the server. The selection text can be queried and changed
123	by calling C<< $term->selection >>.	171	by calling C<< $term->selection >>.
124		172
125	Returning a true value aborts selection grabbing. It will still be hilighted.	173	Returning a true value aborts selection grabbing. It will still be hilighted.
126		174
		175	=item on_sel_extend $term
		176
		177	Called whenever the user tries to extend the selection (e.g. with a double
		178	click) and is either supposed to return false (normal operation), or
		179	should extend the selection itelf and return true to suppress the built-in
		180	processing.
		181
		182	See the F<selection> example extension.
		183
127	=item on_focus_in $term	184	=item on_focus_in $term
128		185
129	Called whenever the window gets the keyboard focus, before urxvt does	186	Called whenever the window gets the keyboard focus, before urxvt does
130	focus in processing.	187	focus in processing.
131		188
…		…
151	number of lines that will be in the scrollback buffer.	208	number of lines that will be in the scrollback buffer.
152		209
153	=item on_tty_activity $term NYI	210	=item on_tty_activity $term NYI
154		211
155	Called whenever the program(s) running in the urxvt window send output.	212	Called whenever the program(s) running in the urxvt window send output.
		213
		214	=item on_osc_seq $term, $string
		215
		216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		217	operating system command) is processed. Cursor position and other state
		218	information is up-to-date when this happens. For interoperability, the
		219	string should start with the extension name and a colon, to distinguish
		220	it from commands for other extensions, and this might be enforced in the
		221	future.
		222
		223	Be careful not ever to trust (in a security sense) the data you receive,
		224	as its source can not easily be controleld (e-mail content, messages from
		225	other users on the same system etc.).
		226
		227	=item on_add_lines $term, $string
		228
		229	Called whenever text is about to be output, with the text as argument. You
		230	can filter/change and output the text yourself by returning a true value
		231	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		232	might be very slow, however, as your hook is called for B<all> text being
		233	output.
		234
		235	=item on_line_update $term, $row
		236
		237	Called whenever a line was updated or changed. Can be used to filter
		238	screen output (e.g. underline urls or other useless stuff). Only lines
		239	that are being shown will be filtered, and, due to performance reasons,
		240	not always immediately.
		241
		242	The row number is always the topmost row of the line if the line spans
		243	multiple rows.
		244
		245	Please note that, if you change the line, then the hook might get called
		246	later with the already-modified line (e.g. if unrelated parts change), so
		247	you cannot just toggle rendition bits, but only set them.
156		248
157	=item on_refresh_begin $term	249	=item on_refresh_begin $term
158		250
159	Called just before the screen gets redrawn. Can be used for overlay	251	Called just before the screen gets redrawn. Can be used for overlay
160	or similar effects by modify terminal contents in refresh_begin, and	252	or similar effects by modify terminal contents in refresh_begin, and
…		…
169		261
170	Called whenever the user presses a key combination that has a	262	Called whenever the user presses a key combination that has a
171	C<perl:string> action bound to it (see description of the B<keysym>	263	C<perl:string> action bound to it (see description of the B<keysym>
172	resource in the @@RXVT_NAME@@(1) manpage).	264	resource in the @@RXVT_NAME@@(1) manpage).
173		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	Called whenever the corresponding X event is received for the terminal
		277	(see the XEvent manpage) If the hook returns true, then the even will be
		278	ignored by rxvt-unicode.
		279
		280	C<on_key_press> additionally receives the string rxvt-unicode would
		281	output, if any, in locale-specific encoding.
		282
		283	subwindow.
		284
		285	=back
		286
		287	=head2 Variables in the C<urxvt> Package
		288
		289	=over 4
		290
		291	=item $urxvt::TERM
		292
		293	The current terminal. Whenever a callback/Hook is bein executed, this
		294	variable stores the current C<urxvt::term> object.
		295
174	=back	296	=back
175		297
176	=head2 Functions in the C<urxvt> Package	298	=head2 Functions in the C<urxvt> Package
177		299
178	=over 4	300	=over 4
		301
		302	=item $term = new urxvt [arg...]
		303
		304	Creates a new terminal, very similar as if you had started it with
		305	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		306	if the new instance couldn't be created. Returns C<undef> if the new
		307	instance didn't initialise perl, and the terminal object otherwise. The
		308	C<init> and C<start> hooks will be called during the call.
179		309
180	=item urxvt::fatal $errormessage	310	=item urxvt::fatal $errormessage
181		311
182	Fatally aborts execution with the given error message. Avoid at all	312	Fatally aborts execution with the given error message. Avoid at all
183	costs! The only time this is acceptable is when the terminal process	313	costs! The only time this is acceptable is when the terminal process
…		…
193	correct place, e.g. on stderr of the connecting urxvtc client.	323	correct place, e.g. on stderr of the connecting urxvtc client.
194		324
195	=item $time = urxvt::NOW	325	=item $time = urxvt::NOW
196		326
197	Returns the "current time" (as per the event loop).	327	Returns the "current time" (as per the event loop).
		328
		329	=back
198		330
199	=head2 RENDITION	331	=head2 RENDITION
200		332
201	Rendition bitsets contain information about colour, font, font styles and	333	Rendition bitsets contain information about colour, font, font styles and
202	similar information for each screen cell.	334	similar information for each screen cell.
…		…
218	Return the rendition mask used for overlays by default.	350	Return the rendition mask used for overlays by default.
219		351
220	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	352	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
221		353
222	Return the bit that enabled bold, italic, blink, reverse-video and	354	Return the bit that enabled bold, italic, blink, reverse-video and
223	underline, respectively. To enable such a style, just or it onto the	355	underline, respectively. To enable such a style, just logically OR it into
224	bitset.	356	the bitset.
225		357
226	=item $foreground = urxvt::GET_BASEFG $rend	358	=item $foreground = urxvt::GET_BASEFG $rend
227		359
228	=item $background = urxvt::GET_BASEBG $rend	360	=item $background = urxvt::GET_BASEBG $rend
229		361
…		…
234	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	366	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
235		367
236	Replace the foreground/background colour in the rendition mask with the	368	Replace the foreground/background colour in the rendition mask with the
237	specified one.	369	specified one.
238		370
		371	=item $value = urxvt::GET_CUSTOM ($rend)
		372
		373	Return the "custom" value: Every rendition has 5 bits for use by
		374	extensions. They can be set and changed as you like and are initially
		375	zero.
		376
		377	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		378
		379	Change the custom value.
		380
239	=back	381	=back
240		382
241	=cut	383	=cut
242		384
243	package urxvt;	385	package urxvt;
244		386
245	use strict;	387	use strict;
		388	use Scalar::Util ();
246		389
247	our $term;	390	our $TERM;
248	our @HOOKNAME;	391	our @HOOKNAME;
249	our $LIBDIR;	392	our $LIBDIR;
250		393
251	BEGIN {	394	BEGIN {
252	urxvt->bootstrap;	395	urxvt->bootstrap;
…		…
277	my $name = $HOOKNAME[$htype];	420	my $name = $HOOKNAME[$htype];
278		421
279	my $ref = $pkg->can ("on_" . lc $name)	422	my $ref = $pkg->can ("on_" . lc $name)
280	or next;	423	or next;
281		424
282	$term->{_hook}[$htype]{$ref*1} = $ref;	425	$TERM->{_hook}[$htype]{$pkg} = $ref;
283	$hook_count[$htype]++	426	$hook_count[$htype]++
284	or set_should_invoke $htype, 1;	427	or set_should_invoke $htype, 1;
285	}	428	}
286	}	429	}
287		430
…		…
309		452
310	$pkg	453	$pkg
311	}	454	}
312	}	455	}
313		456
		457	our $retval; # return value for urxvt
		458
314	# called by the rxvt core	459	# called by the rxvt core
315	sub invoke {	460	sub invoke {
316	local $term = shift;	461	local $TERM = shift;
317	my $htype = shift;	462	my $htype = shift;
318		463
319	if ($htype == 0) { # INIT	464	if ($htype == 0) { # INIT
320	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	465	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
321		466
322	for my $ext (split /:/, $term->resource ("perl_ext")) {	467	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
323	my @files = grep -f $_, map "$_/$ext", @dirs;	468	my @files = grep -f $_, map "$_/$ext", @dirs;
324		469
325	if (@files) {	470	if (@files) {
326	register_package script_package $files[0];	471	register_package script_package $files[0];
327	} else {	472	} else {
328	warn "perl extension '$ext' not found in perl library search path\n";	473	warn "perl extension '$ext' not found in perl library search path\n";
329	}	474	}
330	}	475	}
		476	}
331		477
		478	$retval = undef;
		479
		480	if (my $cb = $TERM->{_hook}[$htype]) {
		481	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		482	if $verbosity >= 10;
		483
		484	keys %$cb;
		485
		486	while (my ($pkg, $cb) = each %$cb) {
		487	$retval = $cb->(
		488	$TERM->{_pkg}{$pkg} \|\|= do {
		489	my $proxy = bless { }, urxvt::term::proxy::;
		490	Scalar::Util::weaken ($proxy->{term} = $TERM);
		491	$proxy
		492	},
		493	@_,
		494	) and last;
		495	}
		496	}
		497
332	} elsif ($htype == 1) { # DESTROY	498	if ($htype == 1) { # DESTROY
		499	# remove hooks if unused
333	if (my $hook = $term->{_hook}) {	500	if (my $hook = $TERM->{_hook}) {
334	for my $htype (0..$#$hook) {	501	for my $htype (0..$#$hook) {
335	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	502	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
336	or set_should_invoke $htype, 0;	503	or set_should_invoke $htype, 0;
337	}	504	}
338	}	505	}
		506
		507	# clear package objects
		508	%$_ = () for values %{ $TERM->{_pkg} };
		509
		510	# clear package
		511	%$TERM = ();
339	}	512	}
340		513
341	my $cb = $term->{_hook}[$htype]	514	$retval
342	or return;
343
344	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
345	if $verbosity >= 10;
346
347	while (my ($k, $v) = each %$cb) {
348	return 1 if $v->($term, @_);
349	}
350
351	0
352	}	515	}
353		516
354	=back	517	sub urxvt::term::proxy::AUTOLOAD {
		518	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		519	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		520
		521	eval qq{
		522	sub $urxvt::term::proxy::AUTOLOAD {
		523	my \$proxy = shift;
		524	\$proxy->{term}->$1 (\@_)
		525	}
		526	1
		527	} or die "FATAL: unable to compile method forwarder: $@";
		528
		529	goto &$urxvt::term::proxy::AUTOLOAD;
		530	}
355		531
356	=head2 The C<urxvt::term> Class	532	=head2 The C<urxvt::term> Class
357		533
358	=over 4	534	=over 4
		535
		536	=item $term->destroy
		537
		538	Destroy the terminal object (close the window, free resources etc.).
359		539
360	=item $value = $term->resource ($name[, $newval])	540	=item $value = $term->resource ($name[, $newval])
361		541
362	Returns the current resource value associated with a given name and	542	Returns the current resource value associated with a given name and
363	optionally sets a new value. Setting values is most useful in the C<init>	543	optionally sets a new value. Setting values is most useful in the C<init>
…		…
381	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	561	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
382	borderLess color cursorBlink cursorUnderline cutchars delete_key	562	borderLess color cursorBlink cursorUnderline cutchars delete_key
383	display_name embed ext_bwidth fade font geometry hold iconName	563	display_name embed ext_bwidth fade font geometry hold iconName
384	imFont imLocale inputMethod insecure int_bwidth intensityStyles	564	imFont imLocale inputMethod insecure int_bwidth intensityStyles
385	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	565	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
386	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	566	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
387	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	567	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
388	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	568	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
389	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	569	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
390	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	570	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
391	shade term_name title transparent transparent_all tripleclickwords	571	shade term_name title transparent transparent_all tripleclickwords
…		…
397	my ($self, $name) = (shift, shift);	577	my ($self, $name) = (shift, shift);
398	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	578	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
399	goto &urxvt::term::_resource;	579	goto &urxvt::term::_resource;
400	}	580	}
401		581
		582	=item $rend = $term->rstyle ([$new_rstyle])
		583
		584	Return and optionally change the current rendition. Text that is output by
		585	the terminal application will use this style.
		586
		587	=item ($row, $col) = $term->screen_cur ([$row, $col])
		588
		589	Return the current coordinates of the text cursor position and optionally
		590	set it (which is usually bad as applications don't expect that).
		591
402	=item ($row, $col) = $term->selection_mark ([$row, $col])	592	=item ($row, $col) = $term->selection_mark ([$row, $col])
403		593
404	=item ($row, $col) = $term->selection_beg ([$row, $col])	594	=item ($row, $col) = $term->selection_beg ([$row, $col])
405		595
406	=item ($row, $col) = $term->selection_end ([$row, $col])	596	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
415		605
416	=item $oldtext = $term->selection ([$newtext])	606	=item $oldtext = $term->selection ([$newtext])
417		607
418	Return the current selection text and optionally replace it by C<$newtext>.	608	Return the current selection text and optionally replace it by C<$newtext>.
419		609
420	=item $term->scr_overlay ($x, $y, $text)	610	#=item $term->overlay ($x, $y, $text)
421		611	#
422	Create a simple multi-line overlay box. See the next method for details.	612	#Create a simple multi-line overlay box. See the next method for details.
423		613	#
424	=cut	614	#=cut
425		615	#
426	sub urxvt::term::scr_overlay {	616	#sub urxvt::term::scr_overlay {
427	my ($self, $x, $y, $text) = @_;	617	# my ($self, $x, $y, $text) = @_;
428		618	#
429	my @lines = split /\n/, $text;	619	# my @lines = split /\n/, $text;
430		620	#
431	my $w = 0;	621	# my $w = 0;
432	for (map $self->strwidth ($_), @lines) {	622	# for (map $self->strwidth ($_), @lines) {
433	$w = $_ if $w < $_;	623	# $w = $_ if $w < $_;
434	}	624	# }
435		625	#
436	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	626	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
437	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	627	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
438	}	628	#}
439		629
440	=item $term->scr_overlay_new ($x, $y, $width, $height)	630	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
441		631
442	Create a new (empty) overlay at the given position with the given	632	Create a new (empty) overlay at the given position with the given
443	width/height. A border will be put around the box. If either C<$x> or	633	width/height. C<$rstyle> defines the initial rendition style
444	C<$y> is negative, then this is counted from the right/bottom side,	634	(default: C<OVERLAY_RSTYLE>).
445	respectively.
446		635
447	=item $term->scr_overlay_off	636	If C<$border> is C<2> (default), then a decorative border will be put
		637	around the box.
448		638
449	Switch the overlay off again.	639	If either C<$x> or C<$y> is negative, then this is counted from the
		640	right/bottom side, respectively.
450		641
451	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	642	This method returns an urxvt::overlay object. The overlay will be visible
		643	as long as the perl object is referenced.
452		644
453	Put a single character (specified numerically) at the given overlay	645	The methods currently supported on C<urxvt::overlay> objects are:
454	position.
455		646
		647	=over 4
		648
456	=item $term->scr_overlay_set ($x, $y, $text)	649	=item $overlay->set ($x, $y, $text, $rend)
457		650
458	Write a string at the given position into the overlay.	651	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		652	text in rxvt-unicode's special encoding and an array of rendition values
		653	at a specific position inside the overlay.
		654
		655	=item $overlay->hide
		656
		657	If visible, hide the overlay, but do not destroy it.
		658
		659	=item $overlay->show
		660
		661	If hidden, display the overlay again.
		662
		663	=back
459		664
460	=item $cellwidth = $term->strwidth $string	665	=item $cellwidth = $term->strwidth $string
461		666
462	Returns the number of screen-cells this string would need. Correctly	667	Returns the number of screen-cells this string would need. Correctly
463	accounts for wide and combining characters.	668	accounts for wide and combining characters.
…		…
467	Convert the given text string into the corresponding locale encoding.	672	Convert the given text string into the corresponding locale encoding.
468		673
469	=item $string = $term->locale_decode $octets	674	=item $string = $term->locale_decode $octets
470		675
471	Convert the given locale-encoded octets into a perl string.	676	Convert the given locale-encoded octets into a perl string.
		677
		678	=item $term->scr_add_lines ($string)
		679
		680	Write the given text string to the screen, as if output by the application
		681	running inside the terminal. It may not contain command sequences (escape
		682	codes), but is free to use line feeds, carriage returns and tabs. The
		683	string is a normal text string, not in locale-dependent encoding.
		684
		685	Normally its not a good idea to use this function, as programs might be
		686	confused by changes in cursor position or scrolling. Its useful inside a
		687	C<on_add_lines> hook, though.
		688
		689	=item $term->cmd_parse ($octets)
		690
		691	Similar to C<scr_add_lines>, but the argument must be in the
		692	locale-specific encoding of the terminal and can contain command sequences
		693	(escape codes) that will be interpreted.
472		694
473	=item $term->tt_write ($octets)	695	=item $term->tt_write ($octets)
474		696
475	Write the octets given in C<$data> to the tty (i.e. as program input). To	697	Write the octets given in C<$data> to the tty (i.e. as program input). To
476	pass characters instead of octets, you should convert your strings first	698	pass characters instead of octets, you should convert your strings first
477	to the locale-specific encoding using C<< $term->locale_encode >>.	699	to the locale-specific encoding using C<< $term->locale_encode >>.
478		700
		701	=item $window_width = $term->width
		702
		703	=item $window_height = $term->height
		704
		705	=item $font_width = $term->fwidth
		706
		707	=item $font_height = $term->fheight
		708
		709	=item $font_ascent = $term->fbase
		710
479	=item $nrow = $term->nrow	711	=item $terminal_rows = $term->nrow
480		712
481	=item $ncol = $term->ncol	713	=item $terminal_columns = $term->ncol
482		714
483	Return the number of rows/columns of the terminal window (i.e. as	715	=item $has_focus = $term->focus
484	specified by C<-geometry>, excluding any scrollback).
485		716
486	=item $nsaved = $term->nsaved	717	=item $is_mapped = $term->mapped
487		718
488	Returns the number of lines in the scrollback buffer.	719	=item $max_scrollback = $term->saveLines
		720
		721	=item $nrow_plus_saveLines = $term->total_rows
		722
		723	=item $lines_in_scrollback = $term->nsaved
		724
		725	Return various integers describing terminal characteristics.
489		726
490	=item $view_start = $term->view_start ([$newvalue])	727	=item $view_start = $term->view_start ([$newvalue])
491		728
492	Returns the negative row number of the topmost line. Minimum value is	729	Returns the negative row number of the topmost line. Minimum value is
493	C<0>, which displays the normal terminal contents. Larger values scroll	730	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
504	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	741	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
505		742
506	Returns the text of the entire row with number C<$row_number>. Row C<0>	743	Returns the text of the entire row with number C<$row_number>. Row C<0>
507	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	744	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
508	terminal line. The scrollback buffer starts at line C<-1> and extends to	745	terminal line. The scrollback buffer starts at line C<-1> and extends to
509	line C<< -$term->nsaved >>.	746	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		747	is requested.
510		748
511	If C<$new_text> is specified, it will replace characters in the current	749	If C<$new_text> is specified, it will replace characters in the current
512	line, starting at column C<$start_col> (default C<0>), which is useful	750	line, starting at column C<$start_col> (default C<0>), which is useful
513	to replace only parts of a line. The font index in the rendition will	751	to replace only parts of a line. The font index in the rendition will
514	automatically be updated.	752	automatically be updated.
…		…
536		774
537	See the section on RENDITION, above.	775	See the section on RENDITION, above.
538		776
539	=item $length = $term->ROW_l ($row_number[, $new_length])	777	=item $length = $term->ROW_l ($row_number[, $new_length])
540		778
541	Returns the number of screen cells that are in use ("the line length"). If	779	Returns the number of screen cells that are in use ("the line
542	it is C<-1>, then the line is part of a multiple-row logical "line", which	780	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
543	means all characters are in use and it is continued on the next row.	781	line is joined with the following one.
544		782
		783	=item $bool = $term->is_longer ($row_number)
		784
		785	Returns true if the row is part of a multiple-row logical "line" (i.e.
		786	joined with the following row), which means all characters are in use
		787	and it is continued on the next row (and possibly a continuation of the
		788	previous row(s)).
		789
		790	=item $line = $term->line ($row_number)
		791
		792	Create and return a new C<urxvt::line> object that stores information
		793	about the logical line that row C<$row_number> is part of. It supports the
		794	following methods:
		795
		796	=over 4
		797
		798	=item $text = $line->t ([$new_text])
		799
		800	Returns or replaces the full text of the line, similar to C<ROW_t>
		801
		802	=item $rend = $line->r ([$new_rend])
		803
		804	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		805
		806	=item $length = $line->l
		807
		808	Returns the length of the line in cells, similar to C<ROW_l>.
		809
		810	=item $rownum = $line->beg
		811
		812	=item $rownum = $line->end
		813
		814	Return the row number of the first/last row of the line, respectively.
		815
		816	=item $offset = $line->offset_of ($row, $col)
		817
		818	Returns the character offset of the given row\|col pair within the logical
		819	line.
		820
		821	=item ($row, $col) = $line->coord_of ($offset)
		822
		823	Translates a string offset into terminal coordinates again.
		824
		825	=back
		826
		827	=cut
		828
		829	sub urxvt::term::line {
		830	my ($self, $row) = @_;
		831
		832	my $maxrow = $self->nrow - 1;
		833
		834	my ($beg, $end) = ($row, $row);
		835
		836	--$beg while $self->ROW_is_longer ($beg - 1);
		837	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		838
		839	bless {
		840	term => $self,
		841	beg => $beg,
		842	end => $end,
		843	ncol => $self->ncol,
		844	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		845	}, urxvt::line::
		846	}
		847
		848	sub urxvt::line::t {
		849	my ($self) = @_;
		850
		851	if (@_ > 1)
		852	{
		853	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		854	for $self->{beg} .. $self->{end};
		855	}
		856
		857	defined wantarray &&
		858	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		859	0, $self->{len}
		860	}
		861
		862	sub urxvt::line::r {
		863	my ($self) = @_;
		864
		865	if (@_ > 1)
		866	{
		867	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		868	for $self->{beg} .. $self->{end};
		869	}
		870
		871	if (defined wantarray) {
		872	my $rend = [
		873	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		874	];
		875	$#$rend = $self->{len} - 1;
		876	return $rend;
		877	}
		878
		879	()
		880	}
		881
		882	sub urxvt::line::beg { $_[0]{beg} }
		883	sub urxvt::line::end { $_[0]{end} }
		884	sub urxvt::line::l { $_[0]{len} }
		885
		886	sub urxvt::line::offset_of {
		887	my ($self, $row, $col) = @_;
		888
		889	($row - $self->{beg}) * $self->{ncol} + $col
		890	}
		891
		892	sub urxvt::line::coord_of {
		893	my ($self, $offset) = @_;
		894
		895	use integer;
		896
		897	(
		898	$offset / $self->{ncol} + $self->{beg},
		899	$offset % $self->{ncol}
		900	)
		901	}
		902
		903	=item ($row, $col) = $line->coord_of ($offset)
545	=item $text = $term->special_encode $string	904	=item $text = $term->special_encode $string
546		905
547	Converts a perl string into the special encoding used by rxvt-unicode,	906	Converts a perl string into the special encoding used by rxvt-unicode,
548	where one character corresponds to one screen cell. See	907	where one character corresponds to one screen cell. See
549	C<< $term->ROW_t >> for details.	908	C<< $term->ROW_t >> for details.
…		…
558	=head2 The C<urxvt::timer> Class	917	=head2 The C<urxvt::timer> Class
559		918
560	This class implements timer watchers/events. Time is represented as a	919	This class implements timer watchers/events. Time is represented as a
561	fractional number of seconds since the epoch. Example:	920	fractional number of seconds since the epoch. Example:
562		921
563	# create a digital clock display in upper right corner	922	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
564	$term->{timer} = urxvt::timer	923	$term->{timer} = urxvt::timer
565	->new	924	->new
566	->start (urxvt::NOW)	925	->interval (1)
567	->cb (sub {	926	->cb (sub {
568	my ($timer) = @_;
569	my $time = $timer->at;
570	$timer->start ($time + 1);
571	$self->scr_overlay (-1, 0,	927	$term->{overlay}->set (0, 0,
572	POSIX::strftime "%H:%M:%S", localtime $time);	928	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
573	});	929	});
574		930
575	=over 4	931	=over 4
576		932
577	=item $timer = new urxvt::timer	933	=item $timer = new urxvt::timer
578		934
579	Create a new timer object in stopped state.	935	Create a new timer object in started state. It is scheduled to fire
		936	immediately.
580		937
581	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	938	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
582		939
583	Set the callback to be called when the timer triggers.	940	Set the callback to be called when the timer triggers.
584		941
…		…
587	Return the time this watcher will fire next.	944	Return the time this watcher will fire next.
588		945
589	=item $timer = $timer->set ($tstamp)	946	=item $timer = $timer->set ($tstamp)
590		947
591	Set the time the event is generated to $tstamp.	948	Set the time the event is generated to $tstamp.
		949
		950	=item $timer = $timer->interval ($interval)
		951
		952	Normally (and when C<$interval> is C<0>), the timer will automatically
		953	stop after it has fired once. If C<$interval> is non-zero, then the timer
		954	is automatically rescheduled at the given intervals.
592		955
593	=item $timer = $timer->start	956	=item $timer = $timer->start
594		957
595	Start the timer.	958	Start the timer.
596		959
…		…
659	This variable controls the verbosity level of the perl extension. Higher	1022	This variable controls the verbosity level of the perl extension. Higher
660	numbers indicate more verbose output.	1023	numbers indicate more verbose output.
661		1024
662	=over 4	1025	=over 4
663		1026
664	=item 0 - only fatal messages	1027	=item =0 - only fatal messages
665		1028
666	=item 3 - script loading and management	1029	=item =3 - script loading and management
667		1030
668	=item 10 - all events received	1031	=item =10 - all events received
669		1032
670	=back	1033	=back
671		1034
672	=head1 AUTHOR	1035	=head1 AUTHOR
673		1036

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.18 by root, Tue Jan 3 02:01:27 2006 UTC vs. Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.18 by root, Tue Jan 3 02:01:27 2006 UTC vs.
Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC