[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.18 by root, Tue Jan 3 02:01:27 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	* 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		10
15	sub on_sel_grab {	11	sub on_sel_grab {
16	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
17	()	13	()
18	}	14	}
19		15
20	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
21		19
22	=head1 DESCRIPTION	20	=head1 DESCRIPTION
		21
		22	Everytime a terminal object gets created, scripts specified via the
		23	C<perl> resource are loaded and associated with it.
		24
		25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		26	thus must be encoded as UTF-8.
		27
		28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
		29	scripts will be shared (but not enabled) for all terminals.
		30
		31	=head2 Prepackaged Extensions
		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 (colourful, useless).
		65
		66	=back
		67
		68	=head2 General API Considerations
		69
		70	All objects (such as terminals, time watchers etc.) are typical
		71	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
		73	C<_hook>) are reserved for internal uses and must not be accessed or
		74	modified).
		75
		76	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
		78	the like inside the terminal object so they get destroyed as soon as the
		79	terminal is destroyed.
23		80
24	=head2 Hooks	81	=head2 Hooks
25		82
26	The following subroutines can be declared in loaded scripts, and will be called	83	The following subroutines can be declared in loaded scripts, and will be called
27	whenever the relevant event happens.	84	whenever the relevant event happens.
106		163
107	=item on_refresh_end $term	164	=item on_refresh_end $term
108		165
109	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>.
110		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).
		173
111	=back	174	=back
112		175
113	=head2 Functions in the C<urxvt> Package	176	=head2 Functions in the C<urxvt> Package
114		177
115	=over 4	178	=over 4
…		…
120	costs! The only time this is acceptable is when the terminal process	183	costs! The only time this is acceptable is when the terminal process
121	starts up.	184	starts up.
122		185
123	=item urxvt::warn $string	186	=item urxvt::warn $string
124		187
125	Calls C<rxvt_warn> witht eh given string which should not include a	188	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	189	newline. The module also overwrites the C<warn> builtin with a function
127	that calls this function.	190	that calls this function.
128		191
129	Using this function has the advantage that its output ends up in the	192	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.	193	correct place, e.g. on stderr of the connecting urxvtc client.
131		194
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
137	=item $time = urxvt::NOW	195	=item $time = urxvt::NOW
138		196
139	Returns the "current time" (as per the event loop).	197	Returns the "current time" (as per the event loop).
		198
		199	=head2 RENDITION
		200
		201	Rendition bitsets contain information about colour, font, font styles and
		202	similar information for each screen cell.
		203
		204	The following "macros" deal with changes in rendition sets. You should
		205	never just create a bitset, you should always modify an existing one,
		206	as they contain important information required for correct operation of
		207	rxvt-unicode.
		208
		209	=over 4
		210
		211	=item $rend = urxvt::DEFAULT_RSTYLE
		212
		213	Returns the default rendition, as used when the terminal is starting up or
		214	being reset. Useful as a base to start when creating renditions.
		215
		216	=item $rend = urxvt::OVERLAY_RSTYLE
		217
		218	Return the rendition mask used for overlays by default.
		219
		220	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		221
		222	Return the bit that enabled bold, italic, blink, reverse-video and
		223	underline, respectively. To enable such a style, just or it onto the
		224	bitset.
		225
		226	=item $foreground = urxvt::GET_BASEFG $rend
		227
		228	=item $background = urxvt::GET_BASEBG $rend
		229
		230	Return the foreground/background colour index, respectively.
		231
		232	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		233
		234	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		235
		236	Replace the foreground/background colour in the rendition mask with the
		237	specified one.
		238
		239	=back
140		240
141	=cut	241	=cut
142		242
143	package urxvt;	243	package urxvt;
144		244
…		…
158	unless $msg =~ /\n$/;	258	unless $msg =~ /\n$/;
159	urxvt::warn ($msg);	259	urxvt::warn ($msg);
160	};	260	};
161	}	261	}
162		262
		263	my @hook_count;
163	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	264	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
164		265
165	sub verbose {	266	sub verbose {
166	my ($level, $msg) = @_;	267	my ($level, $msg) = @_;
167	warn "$msg\n"; #d#	268	warn "$msg\n" if $level <= $verbosity;
168	}	269	}
169		270
170	my @invoke_cb;	271	# find on_xxx subs in the package and register them
		272	# as hooks
		273	sub register_package($) {
		274	my ($pkg) = @_;
		275
		276	for my $htype (0.. $#HOOKNAME) {
		277	my $name = $HOOKNAME[$htype];
		278
		279	my $ref = $pkg->can ("on_" . lc $name)
		280	or next;
		281
		282	$term->{_hook}[$htype]{$ref*1} = $ref;
		283	$hook_count[$htype]++
		284	or set_should_invoke $htype, 1;
		285	}
		286	}
		287
		288	my $script_pkg = "script0000";
		289	my %script_pkg;
		290
		291	# load a single script into its own package, once only
		292	sub script_package($) {
		293	my ($path) = @_;
		294
		295	$script_pkg{$path} \|\|= do {
		296	my $pkg = "urxvt::" . ($script_pkg++);
		297
		298	verbose 3, "loading script '$path' into package '$pkg'";
		299
		300	open my $fh, "<:raw", $path
		301	or die "$path: $!";
		302
		303	my $source = "package $pkg; use strict; use utf8;\n"
		304	. "#line 1 \"$path\"\n{\n"
		305	. (do { local $/; <$fh> })
		306	. "\n};\n1";
		307
		308	eval $source or die "$path: $@";
		309
		310	$pkg
		311	}
		312	}
171		313
172	# called by the rxvt core	314	# called by the rxvt core
173	sub invoke {	315	sub invoke {
174	local $term = shift;	316	local $term = shift;
175	my $htype = shift;	317	my $htype = shift;
176		318
177	my $cb = $invoke_cb[$htype];	319	if ($htype == 0) { # INIT
		320	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");
		321
		322	for my $ext (split /:/, $term->resource ("perl_ext")) {
		323	my @files = grep -f $_, map "$_/$ext", @dirs;
		324
		325	if (@files) {
		326	register_package script_package $files[0];
		327	} else {
		328	warn "perl extension '$ext' not found in perl library search path\n";
		329	}
		330	}
		331
		332	} elsif ($htype == 1) { # DESTROY
		333	if (my $hook = $term->{_hook}) {
		334	for my $htype (0..$#$hook) {
		335	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		336	or set_should_invoke $htype, 0;
		337	}
		338	}
		339	}
		340
		341	my $cb = $term->{_hook}[$htype]
		342	or return;
178		343
179	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	344	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
180	if $verbosity >= 10;	345	if $verbosity >= 10;
181		346
182	while (my ($k, $v) = each %$cb) {	347	while (my ($k, $v) = each %$cb) {
…		…
184	}	349	}
185		350
186	0	351	0
187	}	352	}
188		353
189	# find on_xxx subs in the package and register them	354	=back
190	# as hooks
191	sub register_package($) {
192	my ($pkg) = @_;
193		355
194	for my $hook (0.. $#HOOKNAME) {	356	=head2 The C<urxvt::term> Class
195	my $name = $HOOKNAME[$hook];
196		357
197	my $ref = $pkg->can ("on_" . lc $name)	358	=over 4
198	or next;
199		359
200	$invoke_cb[$hook]{$ref*1} = $ref;	360	=item $value = $term->resource ($name[, $newval])
201	set_should_invoke $hook, 1;	361
202	}	362	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>
		364	hook. Unset resources are returned and accepted as C<undef>.
		365
		366	The new value must be properly encoded to a suitable character encoding
		367	before passing it to this method. Similarly, the returned value may need
		368	to be converted from the used encoding to text.
		369
		370	Resource names are as defined in F<src/rsinc.h>. Colours can be specified
		371	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
		372	likely change).
		373
		374	Please note that resource strings will currently only be freed when the
		375	terminal is destroyed, so changing options frequently will eat memory.
		376
		377	Here is a a likely non-exhaustive list of resource names, not all of which
		378	are supported in every build, please see the source to see the actual
		379	list:
		380
		381	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
		382	borderLess color cursorBlink cursorUnderline cutchars delete_key
		383	display_name embed ext_bwidth fade font geometry hold iconName
		384	imFont imLocale inputMethod insecure int_bwidth intensityStyles
		385	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
		386	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
		387	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
		388	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
		389	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
		390	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
		391	shade term_name title transparent transparent_all tripleclickwords
		392	utmpInhibit visualBell
		393
		394	=cut
		395
		396	sub urxvt::term::resource($$;$) {
		397	my ($self, $name) = (shift, shift);
		398	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
		399	goto &urxvt::term::_resource;
203	}	400	}
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		401
239	=item ($row, $col) = $term->selection_mark ([$row, $col])	402	=item ($row, $col) = $term->selection_mark ([$row, $col])
240		403
241	=item ($row, $col) = $term->selection_beg ([$row, $col])	404	=item ($row, $col) = $term->selection_beg ([$row, $col])
242		405
…		…
264	my ($self, $x, $y, $text) = @_;	427	my ($self, $x, $y, $text) = @_;
265		428
266	my @lines = split /\n/, $text;	429	my @lines = split /\n/, $text;
267		430
268	my $w = 0;	431	my $w = 0;
269	for (map urxvt::wcswidth $_, @lines) {	432	for (map $self->strwidth ($_), @lines) {
270	$w = $_ if $w < $_;	433	$w = $_ if $w < $_;
271	}	434	}
272		435
273	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	436	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
274	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	437	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
…		…
291	position.	454	position.
292		455
293	=item $term->scr_overlay_set ($x, $y, $text)	456	=item $term->scr_overlay_set ($x, $y, $text)
294		457
295	Write a string at the given position into the overlay.	458	Write a string at the given position into the overlay.
		459
		460	=item $cellwidth = $term->strwidth $string
		461
		462	Returns the number of screen-cells this string would need. Correctly
		463	accounts for wide and combining characters.
		464
		465	=item $octets = $term->locale_encode $string
		466
		467	Convert the given text string into the corresponding locale encoding.
		468
		469	=item $string = $term->locale_decode $octets
		470
		471	Convert the given locale-encoded octets into a perl string.
		472
		473	=item $term->tt_write ($octets)
		474
		475	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
		477	to the locale-specific encoding using C<< $term->locale_encode >>.
		478
		479	=item $nrow = $term->nrow
		480
		481	=item $ncol = $term->ncol
		482
		483	Return the number of rows/columns of the terminal window (i.e. as
		484	specified by C<-geometry>, excluding any scrollback).
		485
		486	=item $nsaved = $term->nsaved
		487
		488	Returns the number of lines in the scrollback buffer.
		489
		490	=item $view_start = $term->view_start ([$newvalue])
		491
		492	Returns the negative row number of the topmost line. Minimum value is
		493	C<0>, which displays the normal terminal contents. Larger values scroll
		494	this many lines into the scrollback buffer.
		495
		496	=item $term->want_refresh
		497
		498	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		499	compare the on-screen display with its stored representation. If they
		500	differ, it redraws the differences.
		501
		502	Used after changing terminal contents to display them.
		503
		504	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		505
		506	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
		508	terminal line. The scrollback buffer starts at line C<-1> and extends to
		509	line C<< -$term->nsaved >>.
		510
		511	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
		513	to replace only parts of a line. The font index in the rendition will
		514	automatically be updated.
		515
		516	C<$text> is in a special encoding: tabs and wide characters that use more
		517	than one cell when displayed are padded with urxvt::NOCHAR characters
		518	(C<chr 65535>). Characters with combining characters and other characters
		519	that do not fit into the normal tetx encoding will be replaced with
		520	characters in the private use area.
		521
		522	You have to obey this encoding when changing text. The advantage is
		523	that C<substr> and similar functions work on screen cells and not on
		524	characters.
		525
		526	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		527	can be used to convert normal strings into this encoding and vice versa.
		528
		529	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		530
		531	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		532	bitsets. Rendition bitsets contain information about colour, font, font
		533	styles and similar information. See also C<< $term->ROW_t >>.
		534
		535	When setting rendition, the font mask will be ignored.
		536
		537	See the section on RENDITION, above.
		538
		539	=item $length = $term->ROW_l ($row_number[, $new_length])
		540
		541	Returns the number of screen cells that are in use ("the line length"). If
		542	it is C<-1>, then the line is part of a multiple-row logical "line", which
		543	means all characters are in use and it is continued on the next row.
		544
		545	=item $text = $term->special_encode $string
		546
		547	Converts a perl string into the special encoding used by rxvt-unicode,
		548	where one character corresponds to one screen cell. See
		549	C<< $term->ROW_t >> for details.
		550
		551	=item $string = $term->special_decode $text
		552
		553	Converts rxvt-unicodes text reprsentation into a perl string. See
		554	C<< $term->ROW_t >> for details.
296		555
297	=back	556	=back
298		557
299	=head2 The C<urxvt::timer> Class	558	=head2 The C<urxvt::timer> Class
300		559
…		…
391		650
392	Stop watching for events on the given filehandle.	651	Stop watching for events on the given filehandle.
393		652
394	=back	653	=back
395		654
		655	=head1 ENVIRONMENT
		656
		657	=head2 URXVT_PERL_VERBOSITY
		658
		659	This variable controls the verbosity level of the perl extension. Higher
		660	numbers indicate more verbose output.
		661
		662	=over 4
		663
		664	=item 0 - only fatal messages
		665
		666	=item 3 - script loading and management
		667
		668	=item 10 - all events received
		669
		670	=back
		671
396	=head1 AUTHOR	672	=head1 AUTHOR
397		673
398	Marc Lehmann <pcg@goof.com>	674	Marc Lehmann <pcg@goof.com>
399	http://software.schmorp.de/pkg/rxvt-unicode	675	http://software.schmorp.de/pkg/rxvt-unicode
400		676

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.18 by root, Tue Jan 3 02:01:27 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.18 by root, Tue Jan 3 02:01:27 2006 UTC