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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.1 by root, Mon Jan 2 15:35:43 2006 UTC vs.
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	urxvt - 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 $LIBDIR/perl-init/, 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 written in 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;
		13	()
17	}	14	}
18		15
19	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
20		19
21	=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.
22		80
23	=head2 Hooks	81	=head2 Hooks
24		82
25	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
26	whenever the relevant event happens.	84	whenever the relevant event happens.
105		163
106	=item on_refresh_end $term	164	=item on_refresh_end $term
107		165
108	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>.
109		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
110	=back	174	=back
111		175
112	=head2 Functions in the C<urxvt> Package	176	=head2 Functions in the C<urxvt> Package
113		177
114	=over 4	178	=over 4
…		…
119	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
120	starts up.	184	starts up.
121		185
122	=item urxvt::warn $string	186	=item urxvt::warn $string
123		187
124	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
125	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
126	that calls this function.	190	that calls this function.
127		191
128	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
129	correct place, e.g. on stderr of the connecting urxvtc client.	193	correct place, e.g. on stderr of the connecting urxvtc client.
130		194
131	=item $cellwidth = urxvt::wcswidth $string
132
133	Returns the number of screen-cells this string would need. Correctly
134	accounts for wide and combining characters.
135
136	=item $time = urxvt::NOW	195	=item $time = urxvt::NOW
137		196
138	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 logically OR it into
		224	the 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	=item $value = urxvt::GET_CUSTOM ($rend)
		240
		241	Return the "custom" value: Every rendition has 5 bits for use by
		242	extensions. They can be set and changed as you like and are initially
		243	zero.
		244
		245	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		246
		247	Change the custom value.
		248
		249	=back
139		250
140	=cut	251	=cut
141		252
142	package urxvt;	253	package urxvt;
143		254
…		…
157	unless $msg =~ /\n$/;	268	unless $msg =~ /\n$/;
158	urxvt::warn ($msg);	269	urxvt::warn ($msg);
159	};	270	};
160	}	271	}
161		272
		273	my @hook_count;
162	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	274	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
163		275
164	sub verbose {	276	sub verbose {
165	my ($level, $msg) = @_;	277	my ($level, $msg) = @_;
166	warn "$msg\n"; #d#	278	warn "$msg\n" if $level <= $verbosity;
167	}	279	}
168		280
169	my @invoke_cb;	281	# find on_xxx subs in the package and register them
		282	# as hooks
		283	sub register_package($) {
		284	my ($pkg) = @_;
		285
		286	for my $htype (0.. $#HOOKNAME) {
		287	my $name = $HOOKNAME[$htype];
		288
		289	my $ref = $pkg->can ("on_" . lc $name)
		290	or next;
		291
		292	$term->{_hook}[$htype]{$ref*1} = $ref;
		293	$hook_count[$htype]++
		294	or set_should_invoke $htype, 1;
		295	}
		296	}
		297
		298	my $script_pkg = "script0000";
		299	my %script_pkg;
		300
		301	# load a single script into its own package, once only
		302	sub script_package($) {
		303	my ($path) = @_;
		304
		305	$script_pkg{$path} \|\|= do {
		306	my $pkg = "urxvt::" . ($script_pkg++);
		307
		308	verbose 3, "loading script '$path' into package '$pkg'";
		309
		310	open my $fh, "<:raw", $path
		311	or die "$path: $!";
		312
		313	my $source = "package $pkg; use strict; use utf8;\n"
		314	. "#line 1 \"$path\"\n{\n"
		315	. (do { local $/; <$fh> })
		316	. "\n};\n1";
		317
		318	eval $source or die "$path: $@";
		319
		320	$pkg
		321	}
		322	}
170		323
171	# called by the rxvt core	324	# called by the rxvt core
172	sub invoke {	325	sub invoke {
173	local $term = shift;	326	local $term = shift;
174	my $htype = shift;	327	my $htype = shift;
175		328
176	my $cb = $invoke_cb[$htype];	329	if ($htype == 0) { # INIT
		330	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");
		331
		332	for my $ext (split /:/, $term->resource ("perl_ext")) {
		333	my @files = grep -f $_, map "$_/$ext", @dirs;
		334
		335	if (@files) {
		336	register_package script_package $files[0];
		337	} else {
		338	warn "perl extension '$ext' not found in perl library search path\n";
		339	}
		340	}
		341
		342	} elsif ($htype == 1) { # DESTROY
		343	if (my $hook = $term->{_hook}) {
		344	for my $htype (0..$#$hook) {
		345	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		346	or set_should_invoke $htype, 0;
		347	}
		348	}
		349	}
		350
		351	my $cb = $term->{_hook}[$htype]
		352	or return;
177		353
178	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	354	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
179	if $verbosity >= 10;	355	if $verbosity >= 10;
180		356
181	while (my ($k, $v) = each %$cb) {	357	while (my ($k, $v) = each %$cb) {
…		…
183	}	359	}
184		360
185	0	361	0
186	}	362	}
187		363
188	# find on_xxx subs in the package and register them	364	=back
189	# as hooks
190	sub register_package($) {
191	my ($pkg) = @_;
192		365
193	for my $hook (0.. $#HOOKNAME) {	366	=head2 The C<urxvt::term> Class
194	my $name = $HOOKNAME[$hook];
195		367
196	my $ref = $pkg->can ("on_" . lc $name)	368	=over 4
197	or next;
198		369
199	$invoke_cb[$hook]{$ref*1} = $ref;	370	=item $value = $term->resource ($name[, $newval])
200	set_should_invoke $hook, 1;	371
201	}	372	Returns the current resource value associated with a given name and
		373	optionally sets a new value. Setting values is most useful in the C<init>
		374	hook. Unset resources are returned and accepted as C<undef>.
		375
		376	The new value must be properly encoded to a suitable character encoding
		377	before passing it to this method. Similarly, the returned value may need
		378	to be converted from the used encoding to text.
		379
		380	Resource names are as defined in F<src/rsinc.h>. Colours can be specified
		381	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
		382	likely change).
		383
		384	Please note that resource strings will currently only be freed when the
		385	terminal is destroyed, so changing options frequently will eat memory.
		386
		387	Here is a a likely non-exhaustive list of resource names, not all of which
		388	are supported in every build, please see the source to see the actual
		389	list:
		390
		391	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
		392	borderLess color cursorBlink cursorUnderline cutchars delete_key
		393	display_name embed ext_bwidth fade font geometry hold iconName
		394	imFont imLocale inputMethod insecure int_bwidth intensityStyles
		395	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
		396	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
		397	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
		398	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
		399	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
		400	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
		401	shade term_name title transparent transparent_all tripleclickwords
		402	utmpInhibit visualBell
		403
		404	=cut
		405
		406	sub urxvt::term::resource($$;$) {
		407	my ($self, $name) = (shift, shift);
		408	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
		409	goto &urxvt::term::_resource;
202	}	410	}
203
204	my $script_pkg = "script0000";
205	my %script_pkg;
206
207	# load a single script into its own package, once only
208	sub load_script($) {
209	my ($path) = @_;
210
211	$script_pkg{$path} \|\|= do {
212	my $pkg = $script_pkg++;
213	verbose 3, "loading script '$path' into package '$pkg'";
214
215	open my $fh, "<:raw", $path
216	or die "$path: $!";
217
218	eval "package $pkg; use strict; use utf8;\n"
219	. "#line 1 \"$path\"\n"
220	. do { local $/; <$fh> }
221	or die "$path: $@";
222
223	register_package $pkg;
224
225	$pkg
226	};
227	}
228
229	load_script $_ for grep -f $_, <$LIBDIR/perl-init/*>;
230
231
232	=back
233
234	=head2 The C<urxvt::term> Class
235
236	=over 4
237		411
238	=item ($row, $col) = $term->selection_mark ([$row, $col])	412	=item ($row, $col) = $term->selection_mark ([$row, $col])
239		413
240	=item ($row, $col) = $term->selection_beg ([$row, $col])	414	=item ($row, $col) = $term->selection_beg ([$row, $col])
241		415
…		…
263	my ($self, $x, $y, $text) = @_;	437	my ($self, $x, $y, $text) = @_;
264		438
265	my @lines = split /\n/, $text;	439	my @lines = split /\n/, $text;
266		440
267	my $w = 0;	441	my $w = 0;
268	for (map urxvt::wcswidth $_, @lines) {	442	for (map $self->strwidth ($_), @lines) {
269	$w = $_ if $w < $_;	443	$w = $_ if $w < $_;
270	}	444	}
271		445
272	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	446	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
273	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	447	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
…		…
290	position.	464	position.
291		465
292	=item $term->scr_overlay_set ($x, $y, $text)	466	=item $term->scr_overlay_set ($x, $y, $text)
293		467
294	Write a string at the given position into the overlay.	468	Write a string at the given position into the overlay.
		469
		470	=item $cellwidth = $term->strwidth $string
		471
		472	Returns the number of screen-cells this string would need. Correctly
		473	accounts for wide and combining characters.
		474
		475	=item $octets = $term->locale_encode $string
		476
		477	Convert the given text string into the corresponding locale encoding.
		478
		479	=item $string = $term->locale_decode $octets
		480
		481	Convert the given locale-encoded octets into a perl string.
		482
		483	=item $term->tt_write ($octets)
		484
		485	Write the octets given in C<$data> to the tty (i.e. as program input). To
		486	pass characters instead of octets, you should convert your strings first
		487	to the locale-specific encoding using C<< $term->locale_encode >>.
		488
		489	=item $nrow = $term->nrow
		490
		491	=item $ncol = $term->ncol
		492
		493	Return the number of rows/columns of the terminal window (i.e. as
		494	specified by C<-geometry>, excluding any scrollback).
		495
		496	=item $nsaved = $term->nsaved
		497
		498	Returns the number of lines in the scrollback buffer.
		499
		500	=item $view_start = $term->view_start ([$newvalue])
		501
		502	Returns the negative row number of the topmost line. Minimum value is
		503	C<0>, which displays the normal terminal contents. Larger values scroll
		504	this many lines into the scrollback buffer.
		505
		506	=item $term->want_refresh
		507
		508	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		509	compare the on-screen display with its stored representation. If they
		510	differ, it redraws the differences.
		511
		512	Used after changing terminal contents to display them.
		513
		514	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		515
		516	Returns the text of the entire row with number C<$row_number>. Row C<0>
		517	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		518	terminal line. The scrollback buffer starts at line C<-1> and extends to
		519	line C<< -$term->nsaved >>.
		520
		521	If C<$new_text> is specified, it will replace characters in the current
		522	line, starting at column C<$start_col> (default C<0>), which is useful
		523	to replace only parts of a line. The font index in the rendition will
		524	automatically be updated.
		525
		526	C<$text> is in a special encoding: tabs and wide characters that use more
		527	than one cell when displayed are padded with urxvt::NOCHAR characters
		528	(C<chr 65535>). Characters with combining characters and other characters
		529	that do not fit into the normal tetx encoding will be replaced with
		530	characters in the private use area.
		531
		532	You have to obey this encoding when changing text. The advantage is
		533	that C<substr> and similar functions work on screen cells and not on
		534	characters.
		535
		536	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		537	can be used to convert normal strings into this encoding and vice versa.
		538
		539	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		540
		541	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		542	bitsets. Rendition bitsets contain information about colour, font, font
		543	styles and similar information. See also C<< $term->ROW_t >>.
		544
		545	When setting rendition, the font mask will be ignored.
		546
		547	See the section on RENDITION, above.
		548
		549	=item $length = $term->ROW_l ($row_number[, $new_length])
		550
		551	Returns the number of screen cells that are in use ("the line length"). If
		552	it is C<-1>, then the line is part of a multiple-row logical "line", which
		553	means all characters are in use and it is continued on the next row.
		554
		555	=item $text = $term->special_encode $string
		556
		557	Converts a perl string into the special encoding used by rxvt-unicode,
		558	where one character corresponds to one screen cell. See
		559	C<< $term->ROW_t >> for details.
		560
		561	=item $string = $term->special_decode $text
		562
		563	Converts rxvt-unicodes text reprsentation into a perl string. See
		564	C<< $term->ROW_t >> for details.
295		565
296	=back	566	=back
297		567
298	=head2 The C<urxvt::timer> Class	568	=head2 The C<urxvt::timer> Class
299		569
…		…
390		660
391	Stop watching for events on the given filehandle.	661	Stop watching for events on the given filehandle.
392		662
393	=back	663	=back
394		664
		665	=head1 ENVIRONMENT
		666
		667	=head2 URXVT_PERL_VERBOSITY
		668
		669	This variable controls the verbosity level of the perl extension. Higher
		670	numbers indicate more verbose output.
		671
		672	=over 4
		673
		674	=item 0 - only fatal messages
		675
		676	=item 3 - script loading and management
		677
		678	=item 10 - all events received
		679
		680	=back
		681
395	=head1 AUTHOR	682	=head1 AUTHOR
396		683
397	Marc Lehmann <pcg@goof.com>	684	Marc Lehmann <pcg@goof.com>
398	http://software.schmorp.de/pkg/rxvt-unicode	685	http://software.schmorp.de/pkg/rxvt-unicode
399		686

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.1 by root, Mon Jan 2 15:35:43 2006 UTC vs. Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.1 by root, Mon Jan 2 15:35:43 2006 UTC vs.
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC