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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.7 by root, Mon Jan 2 19:05:05 2006 UTC vs.
Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	rxvtperl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
6		8
7	* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically.	9	# create a file grab_test in $HOME:
8
9	* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
10	thus must be encoded as UTF-8.
11		10
12	sub on_sel_grab {	11	sub on_sel_grab {
13	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
14	()	13	()
15	}	14	}
16		15
17	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
18		19
19	=head1 DESCRIPTION	20	=head1 DESCRIPTION
20		21
21	On startup, @@RXVT_NAME@@ will scan F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>	22	Everytime a terminal object gets created, scripts specified via the
22	for files and will load them. Everytime a terminal object gets created,	23	C<perl> resource are loaded and associated with it.
23	the directory specified by the C<perl-lib> resource will be additionally	24
24	scanned.	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		26	thus must be encoded as UTF-8.
25		27
26	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
27	scripts will be shared for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
28		30
29	Hooks in scripts specified by C<perl-lib> will only be called for the	31	=head2 Prepackaged Extensions
30	terminals created with that specific option value.	32
		33	This section describes the extensiosn delivered with this version. You can
		34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		35
		36	You can activate them like this:
		37
		38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	=over 4
		41
		42	=item selection
		43
		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:
		50
		51	=over 4
		52
		53	=item rot13
		54
		55	Rot-13 the selection when activated. Used via keyboard trigger:
		56
		57	URxvt.keysym.C-M-r: perl:selection:rot13
		58
		59	=back
		60
		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
		70
		71	Displays a very simple digital clock in the upper right corner of the
		72	window. Illustrates overwriting the refresh callbacks to create your own
		73	overlays or changes.
		74
		75	=item example-filter-input
		76
		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.
		81
		82	=back
31		83
32	=head2 General API Considerations	84	=head2 General API Considerations
33		85
34	All objects (such as terminals, time watchers etc.) are typical	86	All objects (such as terminals, time watchers etc.) are typical
35	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
36	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
37	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
38	modified).	90	modified).
39		91
40	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
41	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
42	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
43	terminal is destroyed.	95	terminal is destroyed.
44		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
45	=head2 Hooks	120	=head2 Hooks
46		121
47	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
48	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.
49		130
50	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
51	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,
52	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.
53		134
56	=over 4	137	=over 4
57		138
58	=item on_init $term	139	=item on_init $term
59		140
60	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
61	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.
62		146
63	=item on_reset $term	147	=item on_reset $term
64		148
65	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
66	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
…		…
86	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
87	by calling C<< $term->selection >>.	171	by calling C<< $term->selection >>.
88		172
89	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.
90		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
91	=item on_focus_in $term	184	=item on_focus_in $term
92		185
93	Called whenever the window gets the keyboard focus, before urxvt does	186	Called whenever the window gets the keyboard focus, before urxvt does
94	focus in processing.	187	focus in processing.
95		188
…		…
115	number of lines that will be in the scrollback buffer.	208	number of lines that will be in the scrollback buffer.
116		209
117	=item on_tty_activity $term NYI	210	=item on_tty_activity $term NYI
118		211
119	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.
120		248
121	=item on_refresh_begin $term	249	=item on_refresh_begin $term
122		250
123	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
124	or similar effects by modify terminal contents in refresh_begin, and	252	or similar effects by modify terminal contents in refresh_begin, and
…		…
127		255
128	=item on_refresh_end $term	256	=item on_refresh_end $term
129		257
130	Called just after the screen gets redrawn. See C<on_refresh_begin>.	258	Called just after the screen gets redrawn. See C<on_refresh_begin>.
131		259
		260	=item on_keyboard_command $term, $string
		261
		262	Called whenever the user presses a key combination that has a
		263	C<perl:string> action bound to it (see description of the B<keysym>
		264	resource in the @@RXVT_NAME@@(1) manpage).
		265
		266	=back
		267
		268	=head2 Variables in the C<urxvt> Package
		269
		270	=over 4
		271
		272	=item $urxvt::TERM
		273
		274	The current terminal. Whenever a callback/Hook is bein executed, this
		275	variable stores the current C<urxvt::term> object.
		276
132	=back	277	=back
133		278
134	=head2 Functions in the C<urxvt> Package	279	=head2 Functions in the C<urxvt> Package
135		280
136	=over 4	281	=over 4
		282
		283	=item $term = new urxvt [arg...]
		284
		285	Creates a new terminal, very similar as if you had started it with
		286	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		287	if the new instance couldn't be created. Returns C<undef> if the new
		288	instance didn't initialise perl, and the terminal object otherwise. The
		289	C<init> and C<start> hooks will be called during the call.
137		290
138	=item urxvt::fatal $errormessage	291	=item urxvt::fatal $errormessage
139		292
140	Fatally aborts execution with the given error message. Avoid at all	293	Fatally aborts execution with the given error message. Avoid at all
141	costs! The only time this is acceptable is when the terminal process	294	costs! The only time this is acceptable is when the terminal process
…		…
152		305
153	=item $time = urxvt::NOW	306	=item $time = urxvt::NOW
154		307
155	Returns the "current time" (as per the event loop).	308	Returns the "current time" (as per the event loop).
156		309
		310	=back
		311
		312	=head2 RENDITION
		313
		314	Rendition bitsets contain information about colour, font, font styles and
		315	similar information for each screen cell.
		316
		317	The following "macros" deal with changes in rendition sets. You should
		318	never just create a bitset, you should always modify an existing one,
		319	as they contain important information required for correct operation of
		320	rxvt-unicode.
		321
		322	=over 4
		323
		324	=item $rend = urxvt::DEFAULT_RSTYLE
		325
		326	Returns the default rendition, as used when the terminal is starting up or
		327	being reset. Useful as a base to start when creating renditions.
		328
		329	=item $rend = urxvt::OVERLAY_RSTYLE
		330
		331	Return the rendition mask used for overlays by default.
		332
		333	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		334
		335	Return the bit that enabled bold, italic, blink, reverse-video and
		336	underline, respectively. To enable such a style, just logically OR it into
		337	the bitset.
		338
		339	=item $foreground = urxvt::GET_BASEFG $rend
		340
		341	=item $background = urxvt::GET_BASEBG $rend
		342
		343	Return the foreground/background colour index, respectively.
		344
		345	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		346
		347	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		348
		349	Replace the foreground/background colour in the rendition mask with the
		350	specified one.
		351
		352	=item $value = urxvt::GET_CUSTOM ($rend)
		353
		354	Return the "custom" value: Every rendition has 5 bits for use by
		355	extensions. They can be set and changed as you like and are initially
		356	zero.
		357
		358	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		359
		360	Change the custom value.
		361
		362	=back
		363
157	=cut	364	=cut
158		365
159	package urxvt;	366	package urxvt;
160		367
161	use strict;	368	use strict;
		369	use Scalar::Util ();
162		370
163	our $term;	371	our $TERM;
164	our @HOOKNAME;	372	our @HOOKNAME;
165	our $LIBDIR;	373	our $LIBDIR;
166		374
167	BEGIN {	375	BEGIN {
168	urxvt->bootstrap;	376	urxvt->bootstrap;
…		…
174	unless $msg =~ /\n$/;	382	unless $msg =~ /\n$/;
175	urxvt::warn ($msg);	383	urxvt::warn ($msg);
176	};	384	};
177	}	385	}
178		386
		387	my @hook_count;
179	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	388	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
180		389
181	sub verbose {	390	sub verbose {
182	my ($level, $msg) = @_;	391	my ($level, $msg) = @_;
183	warn "$msg\n" if $level < $verbosity;	392	warn "$msg\n" if $level <= $verbosity;
184	}
185
186	my %hook_global;
187	my @hook_count;
188
189	# called by the rxvt core
190	sub invoke {
191	local $term = shift;
192	my $htype = shift;
193
194	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
195	if $verbosity >= 10;
196
197	for my $cb ($hook_global{_hook}[$htype], $term->{_hook}[$htype]) {
198	$cb or next;
199
200	while (my ($k, $v) = each %$cb) {
201	return 1 if $v->($term, @_);
202	}
203	}
204
205	0
206	}	393	}
207		394
208	# find on_xxx subs in the package and register them	395	# find on_xxx subs in the package and register them
209	# as hooks	396	# as hooks
210	sub register_package($) {	397	sub register_package($) {
…		…
214	my $name = $HOOKNAME[$htype];	401	my $name = $HOOKNAME[$htype];
215		402
216	my $ref = $pkg->can ("on_" . lc $name)	403	my $ref = $pkg->can ("on_" . lc $name)
217	or next;	404	or next;
218		405
219	$term->{_hook}[$htype]{$ref*1} = $ref;	406	$TERM->{_hook}[$htype]{$pkg} = $ref;
220	$hook_count[$htype]++	407	$hook_count[$htype]++
221	or set_should_invoke $htype, 1;	408	or set_should_invoke $htype, 1;
222	}	409	}
223	}	410	}
224		411
…		…
228	# load a single script into its own package, once only	415	# load a single script into its own package, once only
229	sub script_package($) {	416	sub script_package($) {
230	my ($path) = @_;	417	my ($path) = @_;
231		418
232	$script_pkg{$path} \|\|= do {	419	$script_pkg{$path} \|\|= do {
233	my $pkg = $script_pkg++;	420	my $pkg = "urxvt::" . ($script_pkg++);
		421
234	verbose 3, "loading script '$path' into package '$pkg'";	422	verbose 3, "loading script '$path' into package '$pkg'";
235		423
236	open my $fh, "<:raw", $path	424	open my $fh, "<:raw", $path
237	or die "$path: $!";	425	or die "$path: $!";
238		426
239	eval "package $pkg; use strict; use utf8;\n"	427	my $source = "package $pkg; use strict; use utf8;\n"
240	. "#line 1 \"$path\"\n"	428	. "#line 1 \"$path\"\n{\n"
241	. do { local $/; <$fh> }	429	. (do { local $/; <$fh> })
		430	. "\n};\n1";
		431
242	or die "$path: $@";	432	eval $source or die "$path: $@";
243		433
244	$pkg	434	$pkg
245	}	435	}
246	}	436	}
247		437
248	sub load_scripts($) {	438	our $retval; # return value for urxvt
249	my ($dir) = @_;
250		439
251	verbose 3, "loading scripts from '$dir'";	440	# called by the rxvt core
		441	sub invoke {
		442	local $TERM = shift;
		443	my $htype = shift;
252		444
		445	if ($htype == 0) { # INIT
		446	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		447
		448	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		449	my @files = grep -f $_, map "$_/$ext", @dirs;
		450
		451	if (@files) {
253	register_package script_package $_	452	register_package script_package $files[0];
254	for grep -f $_,	453	} else {
255	<$dir/*>;	454	warn "perl extension '$ext' not found in perl library search path\n";
256	}	455	}
257		456	}
258	sub on_init {
259	my ($term) = @_;
260
261	my $libdir = $term->resource ("perl_lib");
262
263	load_scripts $libdir
264	if defined $libdir;
265	}
266
267	sub on_destroy {
268	my ($term) = @_;
269
270	my $hook = $term->{_hook}
271	or return;
272
273	for my $htype (0..$#$hook) {
274	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
275	or set_should_invoke $htype, 0;
276	}	457	}
277	}
278		458
279	{	459	$retval = undef;
280	local $term = \%hook_global;
281		460
282	register_package __PACKAGE__;	461	if (my $cb = $TERM->{_hook}[$htype]) {
283	load_scripts "$LIBDIR/perl-ext";	462	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
284	}	463	if $verbosity >= 10;
285		464
286	=back	465	keys %$cb;
		466
		467	while (my ($pkg, $cb) = each %$cb) {
		468	$retval = $cb->(
		469	$TERM->{_pkg}{$pkg} \|\|= do {
		470	my $proxy = bless { }, urxvt::term::proxy::;
		471	Scalar::Util::weaken ($proxy->{term} = $TERM);
		472	$proxy
		473	},
		474	@_,
		475	) and last;
		476	}
		477	}
		478
		479	if ($htype == 1) { # DESTROY
		480	# remove hooks if unused
		481	if (my $hook = $TERM->{_hook}) {
		482	for my $htype (0..$#$hook) {
		483	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		484	or set_should_invoke $htype, 0;
		485	}
		486	}
		487
		488	# clear package objects
		489	%$_ = () for values %{ $TERM->{_pkg} };
		490
		491	# clear package
		492	%$TERM = ();
		493	}
		494
		495	$retval
		496	}
		497
		498	sub urxvt::term::proxy::AUTOLOAD {
		499	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		500	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		501
		502	eval qq{
		503	sub $urxvt::term::proxy::AUTOLOAD {
		504	my \$proxy = shift;
		505	\$proxy->{term}->$1 (\@_)
		506	}
		507	1
		508	} or die "FATAL: unable to compile method forwarder: $@";
		509
		510	goto &$urxvt::term::proxy::AUTOLOAD;
		511	}
287		512
288	=head2 The C<urxvt::term> Class	513	=head2 The C<urxvt::term> Class
289		514
290	=over 4	515	=over 4
		516
		517	=item $term->destroy
		518
		519	Destroy the terminal object (close the window, free resources etc.).
291		520
292	=item $value = $term->resource ($name[, $newval])	521	=item $value = $term->resource ($name[, $newval])
293		522
294	Returns the current resource value associated with a given name and	523	Returns the current resource value associated with a given name and
295	optionally sets a new value. Setting values is most useful in the C<init>	524	optionally sets a new value. Setting values is most useful in the C<init>
…		…
312		541
313	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	542	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
314	borderLess color cursorBlink cursorUnderline cutchars delete_key	543	borderLess color cursorBlink cursorUnderline cutchars delete_key
315	display_name embed ext_bwidth fade font geometry hold iconName	544	display_name embed ext_bwidth fade font geometry hold iconName
316	imFont imLocale inputMethod insecure int_bwidth intensityStyles	545	imFont imLocale inputMethod insecure int_bwidth intensityStyles
317	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	546	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
318	modifier mouseWheelScrollPage name pastableTabs path perl perl_eval	547	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
319	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	548	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
320	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	549	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
321	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	550	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
322	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	551	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
323	shade term_name title transparent transparent_all tripleclickwords	552	shade term_name title transparent transparent_all tripleclickwords
…		…
329	my ($self, $name) = (shift, shift);	558	my ($self, $name) = (shift, shift);
330	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	559	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
331	goto &urxvt::term::_resource;	560	goto &urxvt::term::_resource;
332	}	561	}
333		562
		563	=item $rend = $term->rstyle ([$new_rstyle])
		564
		565	Return and optionally change the current rendition. Text that is output by
		566	the terminal application will use this style.
		567
		568	=item ($row, $col) = $term->screen_cur ([$row, $col])
		569
		570	Return the current coordinates of the text cursor position and optionally
		571	set it (which is usually bad as applications don't expect that).
		572
334	=item ($row, $col) = $term->selection_mark ([$row, $col])	573	=item ($row, $col) = $term->selection_mark ([$row, $col])
335		574
336	=item ($row, $col) = $term->selection_beg ([$row, $col])	575	=item ($row, $col) = $term->selection_beg ([$row, $col])
337		576
338	=item ($row, $col) = $term->selection_end ([$row, $col])	577	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
347		586
348	=item $oldtext = $term->selection ([$newtext])	587	=item $oldtext = $term->selection ([$newtext])
349		588
350	Return the current selection text and optionally replace it by C<$newtext>.	589	Return the current selection text and optionally replace it by C<$newtext>.
351		590
352	=item $term->scr_overlay ($x, $y, $text)	591	#=item $term->overlay ($x, $y, $text)
353		592	#
354	Create a simple multi-line overlay box. See the next method for details.	593	#Create a simple multi-line overlay box. See the next method for details.
355		594	#
356	=cut	595	#=cut
357		596	#
358	sub urxvt::term::scr_overlay {	597	#sub urxvt::term::scr_overlay {
359	my ($self, $x, $y, $text) = @_;	598	# my ($self, $x, $y, $text) = @_;
360		599	#
361	my @lines = split /\n/, $text;	600	# my @lines = split /\n/, $text;
362		601	#
363	my $w = 0;	602	# my $w = 0;
364	for (map $self->strwidth ($_), @lines) {	603	# for (map $self->strwidth ($_), @lines) {
365	$w = $_ if $w < $_;	604	# $w = $_ if $w < $_;
366	}	605	# }
367		606	#
368	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	607	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
369	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	608	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
370	}	609	#}
371		610
372	=item $term->scr_overlay_new ($x, $y, $width, $height)	611	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
373		612
374	Create a new (empty) overlay at the given position with the given	613	Create a new (empty) overlay at the given position with the given
375	width/height. A border will be put around the box. If either C<$x> or	614	width/height. C<$rstyle> defines the initial rendition style
376	C<$y> is negative, then this is counted from the right/bottom side,	615	(default: C<OVERLAY_RSTYLE>).
377	respectively.
378		616
379	=item $term->scr_overlay_off	617	If C<$border> is C<2> (default), then a decorative border will be put
		618	around the box.
380		619
381	Switch the overlay off again.	620	If either C<$x> or C<$y> is negative, then this is counted from the
		621	right/bottom side, respectively.
382		622
383	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	623	This method returns an urxvt::overlay object. The overlay will be visible
		624	as long as the perl object is referenced.
384		625
385	Put a single character (specified numerically) at the given overlay	626	The methods currently supported on C<urxvt::overlay> objects are:
386	position.
387		627
		628	=over 4
		629
388	=item $term->scr_overlay_set ($x, $y, $text)	630	=item $overlay->set ($x, $y, $text, $rend)
389		631
390	Write a string at the given position into the overlay.	632	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		633	text in rxvt-unicode's special encoding and an array of rendition values
		634	at a specific position inside the overlay.
		635
		636	=item $overlay->hide
		637
		638	If visible, hide the overlay, but do not destroy it.
		639
		640	=item $overlay->show
		641
		642	If hidden, display the overlay again.
		643
		644	=back
391		645
392	=item $cellwidth = $term->strwidth $string	646	=item $cellwidth = $term->strwidth $string
393		647
394	Returns the number of screen-cells this string would need. Correctly	648	Returns the number of screen-cells this string would need. Correctly
395	accounts for wide and combining characters.	649	accounts for wide and combining characters.
…		…
400		654
401	=item $string = $term->locale_decode $octets	655	=item $string = $term->locale_decode $octets
402		656
403	Convert the given locale-encoded octets into a perl string.	657	Convert the given locale-encoded octets into a perl string.
404		658
		659	=item $term->scr_add_lines ($string)
		660
		661	Write the given text string to the screen, as if output by the application
		662	running inside the terminal. It may not contain command sequences (escape
		663	codes), but is free to use line feeds, carriage returns and tabs. The
		664	string is a normal text string, not in locale-dependent encoding.
		665
		666	Normally its not a good idea to use this function, as programs might be
		667	confused by changes in cursor position or scrolling. Its useful inside a
		668	C<on_add_lines> hook, though.
		669
		670	=item $term->cmd_parse ($octets)
		671
		672	Similar to C<scr_add_lines>, but the argument must be in the
		673	locale-specific encoding of the terminal and can contain command sequences
		674	(escape codes) that will be interpreted.
		675
405	=item $term->tt_write ($octets)	676	=item $term->tt_write ($octets)
406		677
407	Write the octets given in C<$data> to the tty (i.e. as program input). To	678	Write the octets given in C<$data> to the tty (i.e. as program input). To
408	pass characters instead of octets, you should convetr you strings first to	679	pass characters instead of octets, you should convert your strings first
409	the locale-specific encoding using C<< $term->locale_encode >>.	680	to the locale-specific encoding using C<< $term->locale_encode >>.
		681
		682	=item $window_width = $term->width
		683
		684	=item $window_height = $term->height
		685
		686	=item $font_width = $term->fwidth
		687
		688	=item $font_height = $term->fheight
		689
		690	=item $font_ascent = $term->fbase
		691
		692	=item $terminal_rows = $term->nrow
		693
		694	=item $terminal_columns = $term->ncol
		695
		696	=item $has_focus = $term->focus
		697
		698	=item $is_mapped = $term->mapped
		699
		700	=item $max_scrollback = $term->saveLines
		701
		702	=item $nrow_plus_saveLines = $term->total_rows
		703
		704	=item $lines_in_scrollback = $term->nsaved
		705
		706	Return various integers describing terminal characteristics.
		707
		708	=item $view_start = $term->view_start ([$newvalue])
		709
		710	Returns the negative row number of the topmost line. Minimum value is
		711	C<0>, which displays the normal terminal contents. Larger values scroll
		712	this many lines into the scrollback buffer.
		713
		714	=item $term->want_refresh
		715
		716	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		717	compare the on-screen display with its stored representation. If they
		718	differ, it redraws the differences.
		719
		720	Used after changing terminal contents to display them.
		721
		722	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		723
		724	Returns the text of the entire row with number C<$row_number>. Row C<0>
		725	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		726	terminal line. The scrollback buffer starts at line C<-1> and extends to
		727	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		728	is requested.
		729
		730	If C<$new_text> is specified, it will replace characters in the current
		731	line, starting at column C<$start_col> (default C<0>), which is useful
		732	to replace only parts of a line. The font index in the rendition will
		733	automatically be updated.
		734
		735	C<$text> is in a special encoding: tabs and wide characters that use more
		736	than one cell when displayed are padded with urxvt::NOCHAR characters
		737	(C<chr 65535>). Characters with combining characters and other characters
		738	that do not fit into the normal tetx encoding will be replaced with
		739	characters in the private use area.
		740
		741	You have to obey this encoding when changing text. The advantage is
		742	that C<substr> and similar functions work on screen cells and not on
		743	characters.
		744
		745	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		746	can be used to convert normal strings into this encoding and vice versa.
		747
		748	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		749
		750	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		751	bitsets. Rendition bitsets contain information about colour, font, font
		752	styles and similar information. See also C<< $term->ROW_t >>.
		753
		754	When setting rendition, the font mask will be ignored.
		755
		756	See the section on RENDITION, above.
		757
		758	=item $length = $term->ROW_l ($row_number[, $new_length])
		759
		760	Returns the number of screen cells that are in use ("the line
		761	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		762	line is joined with the following one.
		763
		764	=item $bool = $term->is_longer ($row_number)
		765
		766	Returns true if the row is part of a multiple-row logical "line" (i.e.
		767	joined with the following row), which means all characters are in use
		768	and it is continued on the next row (and possibly a continuation of the
		769	previous row(s)).
		770
		771	=item $line = $term->line ($row_number)
		772
		773	Create and return a new C<urxvt::line> object that stores information
		774	about the logical line that row C<$row_number> is part of. It supports the
		775	following methods:
		776
		777	=over 4
		778
		779	=item $text = $line->t ([$new_text])
		780
		781	Returns or replaces the full text of the line, similar to C<ROW_t>
		782
		783	=item $rend = $line->r ([$new_rend])
		784
		785	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		786
		787	=item $length = $line->l
		788
		789	Returns the length of the line in cells, similar to C<ROW_l>.
		790
		791	=item $rownum = $line->beg
		792
		793	=item $rownum = $line->end
		794
		795	Return the row number of the first/last row of the line, respectively.
		796
		797	=item $offset = $line->offset_of ($row, $col)
		798
		799	Returns the character offset of the given row\|col pair within the logical
		800	line.
		801
		802	=item ($row, $col) = $line->coord_of ($offset)
		803
		804	Translates a string offset into terminal coordinates again.
		805
		806	=back
		807
		808	=cut
		809
		810	sub urxvt::term::line {
		811	my ($self, $row) = @_;
		812
		813	my $maxrow = $self->nrow - 1;
		814
		815	my ($beg, $end) = ($row, $row);
		816
		817	--$beg while $self->ROW_is_longer ($beg - 1);
		818	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		819
		820	bless {
		821	term => $self,
		822	beg => $beg,
		823	end => $end,
		824	ncol => $self->ncol,
		825	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		826	}, urxvt::line::
		827	}
		828
		829	sub urxvt::line::t {
		830	my ($self) = @_;
		831
		832	if (@_ > 1)
		833	{
		834	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		835	for $self->{beg} .. $self->{end};
		836	}
		837
		838	defined wantarray &&
		839	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		840	0, $self->{len}
		841	}
		842
		843	sub urxvt::line::r {
		844	my ($self) = @_;
		845
		846	if (@_ > 1)
		847	{
		848	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		849	for $self->{beg} .. $self->{end};
		850	}
		851
		852	if (defined wantarray) {
		853	my $rend = [
		854	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		855	];
		856	$#$rend = $self->{len} - 1;
		857	return $rend;
		858	}
		859
		860	()
		861	}
		862
		863	sub urxvt::line::beg { $_[0]{beg} }
		864	sub urxvt::line::end { $_[0]{end} }
		865	sub urxvt::line::l { $_[0]{len} }
		866
		867	sub urxvt::line::offset_of {
		868	my ($self, $row, $col) = @_;
		869
		870	($row - $self->{beg}) * $self->{ncol} + $col
		871	}
		872
		873	sub urxvt::line::coord_of {
		874	my ($self, $offset) = @_;
		875
		876	use integer;
		877
		878	(
		879	$offset / $self->{ncol} + $self->{beg},
		880	$offset % $self->{ncol}
		881	)
		882	}
		883
		884	=item ($row, $col) = $line->coord_of ($offset)
		885	=item $text = $term->special_encode $string
		886
		887	Converts a perl string into the special encoding used by rxvt-unicode,
		888	where one character corresponds to one screen cell. See
		889	C<< $term->ROW_t >> for details.
		890
		891	=item $string = $term->special_decode $text
		892
		893	Converts rxvt-unicodes text reprsentation into a perl string. See
		894	C<< $term->ROW_t >> for details.
410		895
411	=back	896	=back
412		897
413	=head2 The C<urxvt::timer> Class	898	=head2 The C<urxvt::timer> Class
414		899
415	This class implements timer watchers/events. Time is represented as a	900	This class implements timer watchers/events. Time is represented as a
416	fractional number of seconds since the epoch. Example:	901	fractional number of seconds since the epoch. Example:
417		902
418	# create a digital clock display in upper right corner	903	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
419	$term->{timer} = urxvt::timer	904	$term->{timer} = urxvt::timer
420	->new	905	->new
421	->start (urxvt::NOW)	906	->interval (1)
422	->cb (sub {	907	->cb (sub {
423	my ($timer) = @_;
424	my $time = $timer->at;
425	$timer->start ($time + 1);
426	$self->scr_overlay (-1, 0,	908	$term->{overlay}->set (0, 0,
427	POSIX::strftime "%H:%M:%S", localtime $time);	909	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
428	});	910	});
429		911
430	=over 4	912	=over 4
431		913
432	=item $timer = new urxvt::timer	914	=item $timer = new urxvt::timer
433		915
434	Create a new timer object in stopped state.	916	Create a new timer object in started state. It is scheduled to fire
		917	immediately.
435		918
436	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	919	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
437		920
438	Set the callback to be called when the timer triggers.	921	Set the callback to be called when the timer triggers.
439		922
…		…
442	Return the time this watcher will fire next.	925	Return the time this watcher will fire next.
443		926
444	=item $timer = $timer->set ($tstamp)	927	=item $timer = $timer->set ($tstamp)
445		928
446	Set the time the event is generated to $tstamp.	929	Set the time the event is generated to $tstamp.
		930
		931	=item $timer = $timer->interval ($interval)
		932
		933	Normally (and when C<$interval> is C<0>), the timer will automatically
		934	stop after it has fired once. If C<$interval> is non-zero, then the timer
		935	is automatically rescheduled at the given intervals.
447		936
448	=item $timer = $timer->start	937	=item $timer = $timer->start
449		938
450	Start the timer.	939	Start the timer.
451		940
…		…
514	This variable controls the verbosity level of the perl extension. Higher	1003	This variable controls the verbosity level of the perl extension. Higher
515	numbers indicate more verbose output.	1004	numbers indicate more verbose output.
516		1005
517	=over 4	1006	=over 4
518		1007
519	=item 0 - only fatal messages	1008	=item =0 - only fatal messages
520		1009
521	=item 3 - script loading and management	1010	=item =3 - script loading and management
522		1011
523	=item 10 - all events received	1012	=item =10 - all events received
524		1013
525	=back	1014	=back
526		1015
527	=head1 AUTHOR	1016	=head1 AUTHOR
528		1017

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.7 by root, Mon Jan 2 19:05:05 2006 UTC vs. Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.7 by root, Mon Jan 2 19:05:05 2006 UTC vs.
Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC