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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.3 by root, Mon Jan 2 15:59:25 2006 UTC vs.
Revision 1.14 by root, Tue Jan 3 01:15:00 2006 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	rxvtperl - rxvt-unicode's embedded perl interpreter	3	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically.	7	# create a file grab_test in $HOME:
8
9	* Each script will only be loaded once, even in urxvtd, and will be valid
10	globally.
11
12	* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
13	thus must be encoded as UTF-8.
14		8
15	sub on_sel_grab {	9	sub on_sel_grab {
16	warn "you selected ", $_[0]->selection;	10	warn "you selected ", $_[0]->selection;
17	()	11	()
18	}	12	}
19		13
20	1	14	# start a @@RXVT_NAME@@ using it:
		15
		16	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
21		17
22	=head1 DESCRIPTION	18	=head1 DESCRIPTION
		19
		20	Everytime a terminal object gets created, scripts specified via the
		21	C<perl> resource are loaded and associated with it.
		22
		23	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		24	thus must be encoded as UTF-8.
		25
		26	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
		27	scripts will be shared (But not enabled) for all terminals.
		28
		29	=head2 General API Considerations
		30
		31	All objects (such as terminals, time watchers etc.) are typical
		32	reference-to-hash objects. The hash can be used to store anything you
		33	like. All members starting with an underscore (such as C<_ptr> or
		34	C<_hook>) are reserved for internal uses and must not be accessed or
		35	modified).
		36
		37	When objects are destroyed on the C++ side, the perl object hashes are
		38	emptied, so its best to store related objects such as time watchers and
		39	the like inside the terminal object so they get destroyed as soon as the
		40	terminal is destroyed.
23		41
24	=head2 Hooks	42	=head2 Hooks
25		43
26	The following subroutines can be declared in loaded scripts, and will be called	44	The following subroutines can be declared in loaded scripts, and will be called
27	whenever the relevant event happens.	45	whenever the relevant event happens.
106		124
107	=item on_refresh_end $term	125	=item on_refresh_end $term
108		126
109	Called just after the screen gets redrawn. See C<on_refresh_begin>.	127	Called just after the screen gets redrawn. See C<on_refresh_begin>.
110		128
		129	=item on_keyboard_command $term, $string
		130
		131	Called whenever the user presses a key combination that has a
		132	C<perl:string> action bound to it (see description of the B<keysym>
		133	resource in the @@RXVT_NAME@@(1) manpage).
		134
111	=back	135	=back
112		136
113	=head2 Functions in the C<urxvt> Package	137	=head2 Functions in the C<urxvt> Package
114		138
115	=over 4	139	=over 4
…		…
120	costs! The only time this is acceptable is when the terminal process	144	costs! The only time this is acceptable is when the terminal process
121	starts up.	145	starts up.
122		146
123	=item urxvt::warn $string	147	=item urxvt::warn $string
124		148
125	Calls C<rxvt_warn> witht eh given string which should not include a	149	Calls C<rxvt_warn> with the given string which should not include a
126	newline. The module also overwrites the C<warn> builtin with a function	150	newline. The module also overwrites the C<warn> builtin with a function
127	that calls this function.	151	that calls this function.
128		152
129	Using this function has the advantage that its output ends up in the	153	Using this function has the advantage that its output ends up in the
130	correct place, e.g. on stderr of the connecting urxvtc client.	154	correct place, e.g. on stderr of the connecting urxvtc client.
131
132	=item $cellwidth = urxvt::wcswidth $string
133
134	Returns the number of screen-cells this string would need. Correctly
135	accounts for wide and combining characters.
136		155
137	=item $time = urxvt::NOW	156	=item $time = urxvt::NOW
138		157
139	Returns the "current time" (as per the event loop).	158	Returns the "current time" (as per the event loop).
140		159
…		…
158	unless $msg =~ /\n$/;	177	unless $msg =~ /\n$/;
159	urxvt::warn ($msg);	178	urxvt::warn ($msg);
160	};	179	};
161	}	180	}
162		181
		182	my @hook_count;
163	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	183	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
164		184
165	sub verbose {	185	sub verbose {
166	my ($level, $msg) = @_;	186	my ($level, $msg) = @_;
167	warn "$msg\n"; #d#	187	warn "$msg\n" if $level <= $verbosity;
168	}	188	}
169		189
170	my @invoke_cb;	190	# find on_xxx subs in the package and register them
		191	# as hooks
		192	sub register_package($) {
		193	my ($pkg) = @_;
		194
		195	for my $htype (0.. $#HOOKNAME) {
		196	my $name = $HOOKNAME[$htype];
		197
		198	my $ref = $pkg->can ("on_" . lc $name)
		199	or next;
		200
		201	$term->{_hook}[$htype]{$ref*1} = $ref;
		202	$hook_count[$htype]++
		203	or set_should_invoke $htype, 1;
		204	}
		205	}
		206
		207	my $script_pkg = "script0000";
		208	my %script_pkg;
		209
		210	# load a single script into its own package, once only
		211	sub script_package($) {
		212	my ($path) = @_;
		213
		214	$script_pkg{$path} \|\|= do {
		215	my $pkg = "urxvt::" . ($script_pkg++);
		216
		217	verbose 3, "loading script '$path' into package '$pkg'";
		218
		219	open my $fh, "<:raw", $path
		220	or die "$path: $!";
		221
		222	my $source = "package $pkg; use strict; use utf8;\n"
		223	. "#line 1 \"$path\"\n{\n"
		224	. (do { local $/; <$fh> })
		225	. "\n};\n1";
		226
		227	eval $source or die "$path: $@";
		228
		229	$pkg
		230	}
		231	}
171		232
172	# called by the rxvt core	233	# called by the rxvt core
173	sub invoke {	234	sub invoke {
174	local $term = shift;	235	local $term = shift;
175	my $htype = shift;	236	my $htype = shift;
176		237
177	my $cb = $invoke_cb[$htype];	238	if ($htype == 0) { # INIT
		239	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");
		240
		241	for my $ext (split /:/, $term->resource ("perl_ext")) {
		242	my @files = grep -f $_, map "$_/$ext", @dirs;
		243
		244	if (@files) {
		245	register_package script_package $files[0];
		246	} else {
		247	warn "perl extension '$ext' not found in perl library search path\n";
		248	}
		249	}
		250
		251	} elsif ($htype == 1) { # DESTROY
		252	if (my $hook = $term->{_hook}) {
		253	for my $htype (0..$#$hook) {
		254	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		255	or set_should_invoke $htype, 0;
		256	}
		257	}
		258	}
		259
		260	my $cb = $term->{_hook}[$htype]
		261	or return;
178		262
179	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	263	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
180	if $verbosity >= 10;	264	if $verbosity >= 10;
181		265
182	while (my ($k, $v) = each %$cb) {	266	while (my ($k, $v) = each %$cb) {
…		…
184	}	268	}
185		269
186	0	270	0
187	}	271	}
188		272
189	# find on_xxx subs in the package and register them	273	=back
190	# as hooks
191	sub register_package($) {
192	my ($pkg) = @_;
193		274
194	for my $hook (0.. $#HOOKNAME) {	275	=head2 The C<urxvt::term> Class
195	my $name = $HOOKNAME[$hook];
196		276
197	my $ref = $pkg->can ("on_" . lc $name)	277	=over 4
198	or next;
199		278
200	$invoke_cb[$hook]{$ref*1} = $ref;	279	=item $value = $term->resource ($name[, $newval])
201	set_should_invoke $hook, 1;	280
202	}	281	Returns the current resource value associated with a given name and
		282	optionally sets a new value. Setting values is most useful in the C<init>
		283	hook. Unset resources are returned and accepted as C<undef>.
		284
		285	The new value must be properly encoded to a suitable character encoding
		286	before passing it to this method. Similarly, the returned value may need
		287	to be converted from the used encoding to text.
		288
		289	Resource names are as defined in F<src/rsinc.h>. Colours can be specified
		290	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
		291	likely change).
		292
		293	Please note that resource strings will currently only be freed when the
		294	terminal is destroyed, so changing options frequently will eat memory.
		295
		296	Here is a a likely non-exhaustive list of resource names, not all of which
		297	are supported in every build, please see the source to see the actual
		298	list:
		299
		300	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
		301	borderLess color cursorBlink cursorUnderline cutchars delete_key
		302	display_name embed ext_bwidth fade font geometry hold iconName
		303	imFont imLocale inputMethod insecure int_bwidth intensityStyles
		304	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
		305	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
		306	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
		307	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
		308	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
		309	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
		310	shade term_name title transparent transparent_all tripleclickwords
		311	utmpInhibit visualBell
		312
		313	=cut
		314
		315	sub urxvt::term::resource($$;$) {
		316	my ($self, $name) = (shift, shift);
		317	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
		318	goto &urxvt::term::_resource;
203	}	319	}
204
205	my $script_pkg = "script0000";
206	my %script_pkg;
207
208	# load a single script into its own package, once only
209	sub load_script($) {
210	my ($path) = @_;
211
212	$script_pkg{$path} \|\|= do {
213	my $pkg = $script_pkg++;
214	verbose 3, "loading script '$path' into package '$pkg'";
215
216	open my $fh, "<:raw", $path
217	or die "$path: $!";
218
219	eval "package $pkg; use strict; use utf8;\n"
220	. "#line 1 \"$path\"\n"
221	. do { local $/; <$fh> }
222	or die "$path: $@";
223
224	register_package $pkg;
225
226	$pkg
227	};
228	}
229
230	load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>;
231
232
233	=back
234
235	=head2 The C<urxvt::term> Class
236
237	=over 4
238		320
239	=item ($row, $col) = $term->selection_mark ([$row, $col])	321	=item ($row, $col) = $term->selection_mark ([$row, $col])
240		322
241	=item ($row, $col) = $term->selection_beg ([$row, $col])	323	=item ($row, $col) = $term->selection_beg ([$row, $col])
242		324
…		…
264	my ($self, $x, $y, $text) = @_;	346	my ($self, $x, $y, $text) = @_;
265		347
266	my @lines = split /\n/, $text;	348	my @lines = split /\n/, $text;
267		349
268	my $w = 0;	350	my $w = 0;
269	for (map urxvt::wcswidth $_, @lines) {	351	for (map $self->strwidth ($_), @lines) {
270	$w = $_ if $w < $_;	352	$w = $_ if $w < $_;
271	}	353	}
272		354
273	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	355	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
274	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	356	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
…		…
292		374
293	=item $term->scr_overlay_set ($x, $y, $text)	375	=item $term->scr_overlay_set ($x, $y, $text)
294		376
295	Write a string at the given position into the overlay.	377	Write a string at the given position into the overlay.
296		378
		379	=item $cellwidth = $term->strwidth $string
		380
		381	Returns the number of screen-cells this string would need. Correctly
		382	accounts for wide and combining characters.
		383
		384	=item $octets = $term->locale_encode $string
		385
		386	Convert the given text string into the corresponding locale encoding.
		387
		388	=item $string = $term->locale_decode $octets
		389
		390	Convert the given locale-encoded octets into a perl string.
		391
		392	=item $term->tt_write ($octets)
		393
		394	Write the octets given in C<$data> to the tty (i.e. as program input). To
		395	pass characters instead of octets, you should convert your strings first
		396	to the locale-specific encoding using C<< $term->locale_encode >>.
		397
		398	=item $nrow = $term->nrow
		399
		400	=item $ncol = $term->ncol
		401
		402	Return the number of rows/columns of the terminal window (i.e. as
		403	specified by C<-geometry>, excluding any scrollback).
		404
		405	=item $nsaved = $term->nsaved
		406
		407	Returns the number of lines in the scrollback buffer.
		408
		409	=item $view_start = $term->view_start ([$newvalue])
		410
		411	Returns the negative row number of the topmost line. Minimum value is
		412	C<0>, which displays the normal terminal contents. Larger values scroll
		413	this many lines into the scrollback buffer.
		414
		415	=item $term->want_refresh
		416
		417	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		418	compare the on-screen display with its stored representation. If they
		419	differ, it redraws the differences.
		420
		421	Used after changing terminal contents to display them.
		422
		423	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		424
		425	Returns the text of the entire row with number C<$row_number>. Row C<0>
		426	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		427	terminal line. The scrollback buffer starts at line C<-1> and extends to
		428	line C<< -$term->nsaved >>.
		429
		430	If C<$new_text> is specified, it will replace characters in the current
		431	line, starting at column C<$start_col> (default C<0>), which is useful
		432	to replace only parts of a line. The font iindex in the rendition will
		433	automatically be updated.
		434
		435	C<$text> is in a special encoding: tabs and wide characters that use more
		436	than one cell when displayed are padded with urxvt::NOCHAR characters
		437	(C<chr 65535>). Characters with combining characters and other characters
		438	that do not fit into the normal tetx encoding will be replaced with
		439	characters in the private use area.
		440
		441	You have to obey this encoding when changing text. The advantage is
		442	that C<substr> and similar functions work on screen cells and not on
		443	characters.
		444
		445	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		446	can be used to convert normal strings into this encoding and vice versa.
		447
		448	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		449
		450	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		451	bitsets. Rendition bitsets contain information about colour, font, font
		452	styles and similar information. See also C<< $term->ROW_t >>.
		453
		454	When setting rendition, the font mask will be ignored.
		455
		456	See the section on RENDITION, below.
		457
		458	=item $length = $term->ROW_l ($row_number[, $new_length])
		459
		460	Returns the number of screen cells that are in use ("the line length"). If
		461	it is C<-1>, then the line is part of a multiple-row logical "line", which
		462	means all characters are in use and it is continued on the next row.
		463
		464	=item $text = $term->special_encode $string
		465
		466	Converts a perl string into the special encoding used by rxvt-unicode,
		467	where one character corresponds to one screen cell. See
		468	C<< $term->ROW_t >> for details.
		469
		470	=item $string = $term->special_decode $text
		471
		472	Converts rxvt-unicodes text reprsentation into a perl string. See
		473	C<< $term->ROW_t >> for details.
		474
297	=back	475	=back
		476
		477	=head2 RENDITION
		478
		479	Rendition bitsets contain information about colour, font, font styles and
		480	similar information for each screen cell.
		481
		482	The following "macros" deal with changes in rendition sets. You should
		483	never just create a bitset, you should always modify an existing one,
		484	as they contain important information required for correct operation of
		485	rxvt-unicode.
		486
		487	=over 4
		488
		489	=item $rend = urxvt::DEFAULT_RSTYLE
		490
		491	Returns the default rendition, as used when the terminal is starting up or
		492	being reset. Useful as a base
		493
		494	=back
		495
		496	=cut
298		497
299	=head2 The C<urxvt::timer> Class	498	=head2 The C<urxvt::timer> Class
300		499
301	This class implements timer watchers/events. Time is represented as a	500	This class implements timer watchers/events. Time is represented as a
302	fractional number of seconds since the epoch. Example:	501	fractional number of seconds since the epoch. Example:
…		…
391		590
392	Stop watching for events on the given filehandle.	591	Stop watching for events on the given filehandle.
393		592
394	=back	593	=back
395		594
		595	=head1 ENVIRONMENT
		596
		597	=head2 URXVT_PERL_VERBOSITY
		598
		599	This variable controls the verbosity level of the perl extension. Higher
		600	numbers indicate more verbose output.
		601
		602	=over 4
		603
		604	=item 0 - only fatal messages
		605
		606	=item 3 - script loading and management
		607
		608	=item 10 - all events received
		609
		610	=back
		611
396	=head1 AUTHOR	612	=head1 AUTHOR
397		613
398	Marc Lehmann <pcg@goof.com>	614	Marc Lehmann <pcg@goof.com>
399	http://software.schmorp.de/pkg/rxvt-unicode	615	http://software.schmorp.de/pkg/rxvt-unicode
400		616

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.3 by root, Mon Jan 2 15:59:25 2006 UTC vs. Revision 1.14 by root, Tue Jan 3 01:15:00 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.3 by root, Mon Jan 2 15:59:25 2006 UTC vs.
Revision 1.14 by root, Tue Jan 3 01:15:00 2006 UTC