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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.6 by root, Mon Jan 2 18:20:23 2006 UTC vs.
Revision 1.17 by root, Tue Jan 3 01:45:03 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	Miscellaneous selection modifications.
		45
		46	=over 4
		47
		48	=item rot13
		49
		50	Rot-13 the selection when activated. Used via keyboard trigger:
		51
		52	URxvt.keysym.C-M-r: perl:selection:rot13
		53
		54	=back
		55
		56	=item digital-clock
		57
		58	Displays a very simple digital clock in the upper right corner of the
		59	window. Illustrates overwriting the refresh callbacks to create your own
		60	overlays or changes.
		61
		62	=item simple-overlay-clock
		63
		64	Displays a digital clock using the built-in overlay (colorful, useless).
		65
		66	=back
31		67
32	=head2 General API Considerations	68	=head2 General API Considerations
33		69
34	All objects (such as terminals, time watchers etc.) are typical	70	All objects (such as terminals, time watchers etc.) are typical
35	reference-to-hash objects. The hash can be used to store anything you	71	reference-to-hash objects. The hash can be used to store anything you
36	like. The only reserved member is C<_ptr>, which must not be changed.	72	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
		74	modified).
37		75
38	When objects are destroyed on the C++ side, the perl object hashes are	76	When objects are destroyed on the C++ side, the perl object hashes are
39	emptied, so its best to store related objects such as time watchers and	77	emptied, so its best to store related objects such as time watchers and
40	the like inside the terminal object so they get destroyed as soon as the	78	the like inside the terminal object so they get destroyed as soon as the
41	terminal is destroyed.	79	terminal is destroyed.
124	code is run after this hook, and takes precedence.	162	code is run after this hook, and takes precedence.
125		163
126	=item on_refresh_end $term	164	=item on_refresh_end $term
127		165
128	Called just after the screen gets redrawn. See C<on_refresh_begin>.	166	Called just after the screen gets redrawn. See C<on_refresh_begin>.
		167
		168	=item on_keyboard_command $term, $string
		169
		170	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>
		172	resource in the @@RXVT_NAME@@(1) manpage).
129		173
130	=back	174	=back
131		175
132	=head2 Functions in the C<urxvt> Package	176	=head2 Functions in the C<urxvt> Package
133		177
…		…
172	unless $msg =~ /\n$/;	216	unless $msg =~ /\n$/;
173	urxvt::warn ($msg);	217	urxvt::warn ($msg);
174	};	218	};
175	}	219	}
176		220
		221	my @hook_count;
177	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	222	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
178		223
179	sub verbose {	224	sub verbose {
180	my ($level, $msg) = @_;	225	my ($level, $msg) = @_;
181	warn "$msg\n"; #d#	226	warn "$msg\n" if $level <= $verbosity;
182	}	227	}
183		228
184	my @invoke_cb;	229	# find on_xxx subs in the package and register them
		230	# as hooks
		231	sub register_package($) {
		232	my ($pkg) = @_;
		233
		234	for my $htype (0.. $#HOOKNAME) {
		235	my $name = $HOOKNAME[$htype];
		236
		237	my $ref = $pkg->can ("on_" . lc $name)
		238	or next;
		239
		240	$term->{_hook}[$htype]{$ref*1} = $ref;
		241	$hook_count[$htype]++
		242	or set_should_invoke $htype, 1;
		243	}
		244	}
		245
		246	my $script_pkg = "script0000";
		247	my %script_pkg;
		248
		249	# load a single script into its own package, once only
		250	sub script_package($) {
		251	my ($path) = @_;
		252
		253	$script_pkg{$path} \|\|= do {
		254	my $pkg = "urxvt::" . ($script_pkg++);
		255
		256	verbose 3, "loading script '$path' into package '$pkg'";
		257
		258	open my $fh, "<:raw", $path
		259	or die "$path: $!";
		260
		261	my $source = "package $pkg; use strict; use utf8;\n"
		262	. "#line 1 \"$path\"\n{\n"
		263	. (do { local $/; <$fh> })
		264	. "\n};\n1";
		265
		266	eval $source or die "$path: $@";
		267
		268	$pkg
		269	}
		270	}
185		271
186	# called by the rxvt core	272	# called by the rxvt core
187	sub invoke {	273	sub invoke {
188	local $term = shift;	274	local $term = shift;
189	my $htype = shift;	275	my $htype = shift;
190		276
191	my $cb = $invoke_cb[$htype];	277	if ($htype == 0) { # INIT
		278	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");
		279
		280	for my $ext (split /:/, $term->resource ("perl_ext")) {
		281	my @files = grep -f $_, map "$_/$ext", @dirs;
		282
		283	if (@files) {
		284	register_package script_package $files[0];
		285	} else {
		286	warn "perl extension '$ext' not found in perl library search path\n";
		287	}
		288	}
		289
		290	} elsif ($htype == 1) { # DESTROY
		291	if (my $hook = $term->{_hook}) {
		292	for my $htype (0..$#$hook) {
		293	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		294	or set_should_invoke $htype, 0;
		295	}
		296	}
		297	}
		298
		299	my $cb = $term->{_hook}[$htype]
		300	or return;
192		301
193	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	302	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
194	if $verbosity >= 10;	303	if $verbosity >= 10;
195		304
196	while (my ($k, $v) = each %$cb) {	305	while (my ($k, $v) = each %$cb) {
197	return 1 if $v->($term, @_);	306	return 1 if $v->($term, @_);
198	}	307	}
199		308
200	0	309	0
201	}	310	}
202
203	# find on_xxx subs in the package and register them
204	# as hooks
205	sub register_package($) {
206	my ($pkg) = @_;
207
208	for my $hook (0.. $#HOOKNAME) {
209	my $name = $HOOKNAME[$hook];
210
211	my $ref = $pkg->can ("on_" . lc $name)
212	or next;
213
214	$invoke_cb[$hook]{$ref*1} = $ref;
215	set_should_invoke $hook, 1;
216	}
217	}
218
219	my $script_pkg = "script0000";
220	my %script_pkg;
221
222	# load a single script into its own package, once only
223	sub load_script($) {
224	my ($path) = @_;
225
226	$script_pkg{$path} \|\|= do {
227	my $pkg = $script_pkg++;
228	verbose 3, "loading script '$path' into package '$pkg'";
229
230	open my $fh, "<:raw", $path
231	or die "$path: $!";
232
233	eval "package $pkg; use strict; use utf8;\n"
234	. "#line 1 \"$path\"\n"
235	. do { local $/; <$fh> }
236	or die "$path: $@";
237
238	register_package $pkg;
239
240	$pkg
241	};
242	}
243
244	sub load_scripts($) {
245	my ($dir) = @_;
246
247	verbose 3, "loading scripts from '$dir'";
248
249	load_script $_
250	for grep -f $_,
251	<$dir/perl-ext/*>;
252	}
253
254	sub on_init {
255	my ($term) = @_;
256
257	my $libdir = $term->resource ("perl_lib");
258
259	load_scripts $libdir
260	if defined $libdir;
261	}
262
263	register_package __PACKAGE__;
264	load_scripts $LIBDIR;
265		311
266	=back	312	=back
267		313
268	=head2 The C<urxvt::term> Class	314	=head2 The C<urxvt::term> Class
269		315
…		…
292		338
293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	339	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
294	borderLess color cursorBlink cursorUnderline cutchars delete_key	340	borderLess color cursorBlink cursorUnderline cutchars delete_key
295	display_name embed ext_bwidth fade font geometry hold iconName	341	display_name embed ext_bwidth fade font geometry hold iconName
296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	342	imFont imLocale inputMethod insecure int_bwidth intensityStyles
297	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	343	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
298	modifier mouseWheelScrollPage name pastableTabs path perl perl_eval	344	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
299	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	345	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
300	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	346	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
301	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	347	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
302	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	348	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
303	shade term_name title transparent transparent_all tripleclickwords	349	shade term_name title transparent transparent_all tripleclickwords
…		…
383	Convert the given locale-encoded octets into a perl string.	429	Convert the given locale-encoded octets into a perl string.
384		430
385	=item $term->tt_write ($octets)	431	=item $term->tt_write ($octets)
386		432
387	Write the octets given in C<$data> to the tty (i.e. as program input). To	433	Write the octets given in C<$data> to the tty (i.e. as program input). To
388	pass characters instead of octets, you should convetr you strings first to	434	pass characters instead of octets, you should convert your strings first
389	the locale-specific encoding using C<< $term->locale_encode >>.	435	to the locale-specific encoding using C<< $term->locale_encode >>.
390		436
		437	=item $nrow = $term->nrow
		438
		439	=item $ncol = $term->ncol
		440
		441	Return the number of rows/columns of the terminal window (i.e. as
		442	specified by C<-geometry>, excluding any scrollback).
		443
		444	=item $nsaved = $term->nsaved
		445
		446	Returns the number of lines in the scrollback buffer.
		447
		448	=item $view_start = $term->view_start ([$newvalue])
		449
		450	Returns the negative row number of the topmost line. Minimum value is
		451	C<0>, which displays the normal terminal contents. Larger values scroll
		452	this many lines into the scrollback buffer.
		453
		454	=item $term->want_refresh
		455
		456	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		457	compare the on-screen display with its stored representation. If they
		458	differ, it redraws the differences.
		459
		460	Used after changing terminal contents to display them.
		461
		462	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		463
		464	Returns the text of the entire row with number C<$row_number>. Row C<0>
		465	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		466	terminal line. The scrollback buffer starts at line C<-1> and extends to
		467	line C<< -$term->nsaved >>.
		468
		469	If C<$new_text> is specified, it will replace characters in the current
		470	line, starting at column C<$start_col> (default C<0>), which is useful
		471	to replace only parts of a line. The font iindex in the rendition will
		472	automatically be updated.
		473
		474	C<$text> is in a special encoding: tabs and wide characters that use more
		475	than one cell when displayed are padded with urxvt::NOCHAR characters
		476	(C<chr 65535>). Characters with combining characters and other characters
		477	that do not fit into the normal tetx encoding will be replaced with
		478	characters in the private use area.
		479
		480	You have to obey this encoding when changing text. The advantage is
		481	that C<substr> and similar functions work on screen cells and not on
		482	characters.
		483
		484	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		485	can be used to convert normal strings into this encoding and vice versa.
		486
		487	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		488
		489	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		490	bitsets. Rendition bitsets contain information about colour, font, font
		491	styles and similar information. See also C<< $term->ROW_t >>.
		492
		493	When setting rendition, the font mask will be ignored.
		494
		495	See the section on RENDITION, below.
		496
		497	=item $length = $term->ROW_l ($row_number[, $new_length])
		498
		499	Returns the number of screen cells that are in use ("the line length"). If
		500	it is C<-1>, then the line is part of a multiple-row logical "line", which
		501	means all characters are in use and it is continued on the next row.
		502
		503	=item $text = $term->special_encode $string
		504
		505	Converts a perl string into the special encoding used by rxvt-unicode,
		506	where one character corresponds to one screen cell. See
		507	C<< $term->ROW_t >> for details.
		508
		509	=item $string = $term->special_decode $text
		510
		511	Converts rxvt-unicodes text reprsentation into a perl string. See
		512	C<< $term->ROW_t >> for details.
		513
391	=back	514	=back
		515
		516	=head2 RENDITION
		517
		518	Rendition bitsets contain information about colour, font, font styles and
		519	similar information for each screen cell.
		520
		521	The following "macros" deal with changes in rendition sets. You should
		522	never just create a bitset, you should always modify an existing one,
		523	as they contain important information required for correct operation of
		524	rxvt-unicode.
		525
		526	=over 4
		527
		528	=item $rend = urxvt::DEFAULT_RSTYLE
		529
		530	Returns the default rendition, as used when the terminal is starting up or
		531	being reset. Useful as a base
		532
		533	=back
		534
		535	=cut
392		536
393	=head2 The C<urxvt::timer> Class	537	=head2 The C<urxvt::timer> Class
394		538
395	This class implements timer watchers/events. Time is represented as a	539	This class implements timer watchers/events. Time is represented as a
396	fractional number of seconds since the epoch. Example:	540	fractional number of seconds since the epoch. Example:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.6 by root, Mon Jan 2 18:20:23 2006 UTC vs. Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.6 by root, Mon Jan 2 18:20:23 2006 UTC vs.
Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC