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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.5 by root, Mon Jan 2 17:20:00 2006 UTC vs.
Revision 1.53 by root, Sun Jan 8 01:16:09 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
23		21
		22	Everytime a terminal object gets created, extension scripts specified via
		23	the 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	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 display filtering (C<on_line_update>) to underline urls.
		68
		69	=item block-graphics-to-ascii
		70
		71	A not very useful example of filtering all text output to the terminal,
		72	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		73	similar-looking ascii character.
		74
		75	=item example-refresh-hooks
		76
		77	Displays a very simple digital clock in the upper right corner of the
		78	window. Illustrates overwriting the refresh callbacks to create your own
		79	overlays or changes.
		80
		81	=back
		82
		83	=head2 General API Considerations
		84
		85	All objects (such as terminals, time watchers etc.) are typical
		86	reference-to-hash objects. The hash can be used to store anything you
		87	like. All members starting with an underscore (such as C<_ptr> or
		88	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
		89	modified).
		90
		91	When objects are destroyed on the C++ side, the perl object hashes are
		92	emptied, so its best to store related objects such as time watchers and
		93	the like inside the terminal object so they get destroyed as soon as the
		94	terminal is destroyed.
		95
		96	Argument names also often indicate the type of a parameter. Here are some
		97	hints on what they mean:
		98
		99	=over 4
		100
		101	=item $text
		102
		103	Rxvt-unicodes special way of encoding text, where one "unicode" character
		104	always represents one screen cell. See L<row_t> for a discussion of this format.
		105
		106	=item $string
		107
		108	A perl text string, with an emphasis on I<text>. It can store all unicode
		109	characters and is to be distinguished with text encoded in a specific
		110	encoding (often locale-specific) and binary data.
		111
		112	=item $octets
		113
		114	Either binary data or - more common - a text string encoded in a
		115	locale-specific way.
		116
		117	=back
		118
24	=head2 Hooks	119	=head2 Hooks
25		120
26	The following subroutines can be declared in loaded scripts, and will be called	121	The following subroutines can be declared in extension files, and will be
27	whenever the relevant event happens.	122	called whenever the relevant event happens.
		123
		124	The first argument passed to them is an object private to each terminal
		125	and extension package. You can call all C<urxvt::term> methods on it, but
		126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		127	object that is shared between all packages is stored in the C<term>
		128	member. It is, however, blessed intot he package of the extension script,
		129	so for all practical purposes you can treat an extension script as a class.
28		130
29	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
30	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,
31	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.
32		134
35	=over 4	137	=over 4
36		138
37	=item on_init $term	139	=item on_init $term
38		140
39	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
40	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.
41		146
42	=item on_reset $term	147	=item on_reset $term
43		148
44	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
45	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
…		…
65	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
66	by calling C<< $term->selection >>.	171	by calling C<< $term->selection >>.
67		172
68	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.
69		174
70	=item on_focus_in $term	175	=item on_sel_extend $term
71		176
72	Called whenever the window gets the keyboard focus, before urxvt does	177	Called whenever the user tries to extend the selection (e.g. with a double
73	focus in processing.	178	click) and is either supposed to return false (normal operation), or
74		179	should extend the selection itelf and return true to suppress the built-in
75	=item on_focus_out $term
76
77	Called wheneever the window loses keyboard focus, before urxvt does focus
78	out processing.	180	processing.
		181
		182	See the F<selection> example extension.
79		183
80	=item on_view_change $term, $offset	184	=item on_view_change $term, $offset
81		185
82	Called whenever the view offset changes, i..e the user or program	186	Called whenever the view offset changes, i..e the user or program
83	scrolls. Offset C<0> means display the normal terminal, positive values	187	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
94	number of lines that will be in the scrollback buffer.	198	number of lines that will be in the scrollback buffer.
95		199
96	=item on_tty_activity $term NYI	200	=item on_tty_activity $term NYI
97		201
98	Called whenever the program(s) running in the urxvt window send output.	202	Called whenever the program(s) running in the urxvt window send output.
		203
		204	=item on_osc_seq $term, $string
		205
		206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		207	operating system command) is processed. Cursor position and other state
		208	information is up-to-date when this happens. For interoperability, the
		209	string should start with the extension name and a colon, to distinguish
		210	it from commands for other extensions, and this might be enforced in the
		211	future.
		212
		213	Be careful not ever to trust (in a security sense) the data you receive,
		214	as its source can not easily be controleld (e-mail content, messages from
		215	other users on the same system etc.).
		216
		217	=item on_add_lines $term, $string
		218
		219	Called whenever text is about to be output, with the text as argument. You
		220	can filter/change and output the text yourself by returning a true value
		221	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		222	might be very slow, however, as your hook is called for B<all> text being
		223	output.
		224
		225	=item on_line_update $term, $row
		226
		227	Called whenever a line was updated or changed. Can be used to filter
		228	screen output (e.g. underline urls or other useless stuff). Only lines
		229	that are being shown will be filtered, and, due to performance reasons,
		230	not always immediately.
		231
		232	The row number is always the topmost row of the line if the line spans
		233	multiple rows.
		234
		235	Please note that, if you change the line, then the hook might get called
		236	later with the already-modified line (e.g. if unrelated parts change), so
		237	you cannot just toggle rendition bits, but only set them.
99		238
100	=item on_refresh_begin $term	239	=item on_refresh_begin $term
101		240
102	Called just before the screen gets redrawn. Can be used for overlay	241	Called just before the screen gets redrawn. Can be used for overlay
103	or similar effects by modify terminal contents in refresh_begin, and	242	or similar effects by modify terminal contents in refresh_begin, and
…		…
106		245
107	=item on_refresh_end $term	246	=item on_refresh_end $term
108		247
109	Called just after the screen gets redrawn. See C<on_refresh_begin>.	248	Called just after the screen gets redrawn. See C<on_refresh_begin>.
110		249
		250	=item on_keyboard_command $term, $string
		251
		252	Called whenever the user presses a key combination that has a
		253	C<perl:string> action bound to it (see description of the B<keysym>
		254	resource in the @@RXVT_NAME@@(1) manpage).
		255
		256	=item on_focus_in $term
		257
		258	Called whenever the window gets the keyboard focus, before rxvt-unicode
		259	does focus in processing.
		260
		261	=item on_focus_out $term
		262
		263	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		264	focus out processing.
		265
		266	=item on_key_press $term, $event, $octets
		267
		268	=item on_key_release $term, $event
		269
		270	=item on_button_press $term, $event
		271
		272	=item on_button_release $term, $event
		273
		274	=item on_motion_notify $term, $event
		275
		276	=item on_map_notify $term, $event
		277
		278	=item on_unmap_notify $term, $event
		279
		280	Called whenever the corresponding X event is received for the terminal If
		281	the hook returns true, then the even will be ignored by rxvt-unicode.
		282
		283	The event is a hash with most values as named by Xlib (see the XEvent
		284	manpage), with the additional members C<row> and C<col>, which are the row
		285	and column under the mouse cursor.
		286
		287	C<on_key_press> additionally receives the string rxvt-unicode would
		288	output, if any, in locale-specific encoding.
		289
		290	subwindow.
		291
111	=back	292	=back
112		293
		294	=head2 Variables in the C<urxvt> Package
		295
		296	=over 4
		297
		298	=item $urxvt::TERM
		299
		300	The current terminal. This variable stores the current C<urxvt::term>
		301	object, whenever a callback/hook is executing.
		302
		303	=back
		304
113	=head2 Functions in the C<urxvt> Package	305	=head2 Functions in the C<urxvt> Package
114		306
115	=over 4	307	=over 4
		308
		309	=item $term = new urxvt [arg...]
		310
		311	Creates a new terminal, very similar as if you had started it with
		312	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		313	if the new instance couldn't be created. Returns C<undef> if the new
		314	instance didn't initialise perl, and the terminal object otherwise. The
		315	C<init> and C<start> hooks will be called during the call.
116		316
117	=item urxvt::fatal $errormessage	317	=item urxvt::fatal $errormessage
118		318
119	Fatally aborts execution with the given error message. Avoid at all	319	Fatally aborts execution with the given error message. Avoid at all
120	costs! The only time this is acceptable is when the terminal process	320	costs! The only time this is acceptable is when the terminal process
121	starts up.	321	starts up.
122		322
123	=item urxvt::warn $string	323	=item urxvt::warn $string
124		324
125	Calls C<rxvt_warn> witht eh given string which should not include a	325	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	326	newline. The module also overwrites the C<warn> builtin with a function
127	that calls this function.	327	that calls this function.
128		328
129	Using this function has the advantage that its output ends up in the	329	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.	330	correct place, e.g. on stderr of the connecting urxvtc client.
131		331
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	332	=item $time = urxvt::NOW
138		333
139	Returns the "current time" (as per the event loop).	334	Returns the "current time" (as per the event loop).
140		335
		336	=item urxvt::CurrentTime
		337
		338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		340	Button4Mask, Button5Mask, AnyModifier
		341
		342	Various constants for use in X events.
		343
		344	=back
		345
		346	=head2 RENDITION
		347
		348	Rendition bitsets contain information about colour, font, font styles and
		349	similar information for each screen cell.
		350
		351	The following "macros" deal with changes in rendition sets. You should
		352	never just create a bitset, you should always modify an existing one,
		353	as they contain important information required for correct operation of
		354	rxvt-unicode.
		355
		356	=over 4
		357
		358	=item $rend = urxvt::DEFAULT_RSTYLE
		359
		360	Returns the default rendition, as used when the terminal is starting up or
		361	being reset. Useful as a base to start when creating renditions.
		362
		363	=item $rend = urxvt::OVERLAY_RSTYLE
		364
		365	Return the rendition mask used for overlays by default.
		366
		367	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		368
		369	Return the bit that enabled bold, italic, blink, reverse-video and
		370	underline, respectively. To enable such a style, just logically OR it into
		371	the bitset.
		372
		373	=item $foreground = urxvt::GET_BASEFG $rend
		374
		375	=item $background = urxvt::GET_BASEBG $rend
		376
		377	Return the foreground/background colour index, respectively.
		378
		379	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		380
		381	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		382
		383	Replace the foreground/background colour in the rendition mask with the
		384	specified one.
		385
		386	=item $value = urxvt::GET_CUSTOM ($rend)
		387
		388	Return the "custom" value: Every rendition has 5 bits for use by
		389	extensions. They can be set and changed as you like and are initially
		390	zero.
		391
		392	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		393
		394	Change the custom value.
		395
		396	=back
		397
141	=cut	398	=cut
142		399
143	package urxvt;	400	package urxvt;
144		401
		402	use utf8;
145	use strict;	403	use strict;
		404	use Scalar::Util ();
		405	use List::Util ();
146		406
147	our $term;	407	our $TERM;
148	our @HOOKNAME;	408	our @HOOKNAME;
		409	our %OPTION;
149	our $LIBDIR;	410	our $LIBDIR;
150		411
151	BEGIN {	412	BEGIN {
152	urxvt->bootstrap;	413	urxvt->bootstrap;
153		414
…		…
158	unless $msg =~ /\n$/;	419	unless $msg =~ /\n$/;
159	urxvt::warn ($msg);	420	urxvt::warn ($msg);
160	};	421	};
161	}	422	}
162		423
		424	my @hook_count;
163	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	425	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
164		426
165	sub verbose {	427	sub verbose {
166	my ($level, $msg) = @_;	428	my ($level, $msg) = @_;
167	warn "$msg\n"; #d#	429	warn "$msg\n" if $level <= $verbosity;
168	}
169
170	my @invoke_cb;
171
172	# called by the rxvt core
173	sub invoke {
174	local $term = shift;
175	my $htype = shift;
176
177	my $cb = $invoke_cb[$htype];
178
179	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
180	if $verbosity >= 10;
181
182	while (my ($k, $v) = each %$cb) {
183	return 1 if $v->($term, @_);
184	}
185
186	0
187	}	430	}
188		431
189	# find on_xxx subs in the package and register them	432	# find on_xxx subs in the package and register them
190	# as hooks	433	# as hooks
191	sub register_package($) {	434	sub register_package($) {
192	my ($pkg) = @_;	435	my ($pkg) = @_;
193		436
194	for my $hook (0.. $#HOOKNAME) {	437	for my $htype (0.. $#HOOKNAME) {
195	my $name = $HOOKNAME[$hook];	438	my $name = $HOOKNAME[$htype];
196		439
197	my $ref = $pkg->can ("on_" . lc $name)	440	my $ref = $pkg->can ("on_" . lc $name)
198	or next;	441	or next;
199		442
200	$invoke_cb[$hook]{$ref*1} = $ref;	443	$TERM->{_hook}[$htype]{$pkg} = $ref;
		444	$hook_count[$htype]++
201	set_should_invoke $hook, 1;	445	or set_should_invoke $htype, 1;
202	}	446	}
203	}	447	}
204		448
205	my $script_pkg = "script0000";	449	my $extension_pkg = "extension0000";
206	my %script_pkg;	450	my %extension_pkg;
207		451
208	# load a single script into its own package, once only	452	# load a single script into its own package, once only
209	sub load_script($) {	453	sub extension_package($) {
210	my ($path) = @_;	454	my ($path) = @_;
211		455
212	$script_pkg{$path} \|\|= do {	456	$extension_pkg{$path} \|\|= do {
213	my $pkg = $script_pkg++;	457	my $pkg = "urxvt::" . ($extension_pkg++);
		458
214	verbose 3, "loading script '$path' into package '$pkg'";	459	verbose 3, "loading extension '$path' into package '$pkg'";
215		460
216	open my $fh, "<:raw", $path	461	open my $fh, "<:raw", $path
217	or die "$path: $!";	462	or die "$path: $!";
218		463
219	eval "package $pkg; use strict; use utf8;\n"	464	my $source = "package $pkg; use strict; use utf8;\n"
		465	. "use base urxvt::term::proxy::;\n"
220	. "#line 1 \"$path\"\n"	466	. "#line 1 \"$path\"\n{\n"
221	. do { local $/; <$fh> }	467	. (do { local $/; <$fh> })
		468	. "\n};\n1";
		469
222	or die "$path: $@";	470	eval $source or die "$path: $@";
223
224	register_package $pkg;
225		471
226	$pkg	472	$pkg
227	};	473	}
228	}	474	}
229		475
230	load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>;	476	our $retval; # return value for urxvt
231		477
232	=back	478	# called by the rxvt core
		479	sub invoke {
		480	local $TERM = shift;
		481	my $htype = shift;
		482
		483	if ($htype == 0) { # INIT
		484	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		485
		486	my %want_ext;
		487
		488	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		489	if ($_ eq "default") {
		490	$want_ext{$_}++ for qw(selection option-popup);
		491	} elsif (/^-(.*)$/) {
		492	delete $want_ext{$1};
		493	} else {
		494	$want_ext{$_}++;
		495	}
		496	}
		497
		498	for my $ext (keys %want_ext) {
		499	my @files = grep -f $_, map "$_/$ext", @dirs;
		500
		501	if (@files) {
		502	register_package extension_package $files[0];
		503	} else {
		504	warn "perl extension '$ext' not found in perl library search path\n";
		505	}
		506	}
		507	}
		508
		509	$retval = undef;
		510
		511	if (my $cb = $TERM->{_hook}[$htype]) {
		512	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		513	if $verbosity >= 10;
		514
		515	keys %$cb;
		516
		517	while (my ($pkg, $cb) = each %$cb) {
		518	eval {
		519	$retval = $cb->(
		520	$TERM->{_pkg}{$pkg} \|\|= do {
		521	my $proxy = bless { }, $pkg;
		522	Scalar::Util::weaken ($proxy->{term} = $TERM);
		523	$proxy
		524	},
		525	@_,
		526	) and last;
		527	};
		528	warn $@ if $@;#d#
		529	}
		530	}
		531
		532	if ($htype == 1) { # DESTROY
		533	# remove hooks if unused
		534	if (my $hook = $TERM->{_hook}) {
		535	for my $htype (0..$#$hook) {
		536	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		537	or set_should_invoke $htype, 0;
		538	}
		539	}
		540
		541	# clear package objects
		542	%$_ = () for values %{ $TERM->{_pkg} };
		543
		544	# clear package
		545	%$TERM = ();
		546	}
		547
		548	$retval
		549	}
		550
		551	sub urxvt::term::proxy::AUTOLOAD {
		552	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		553	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		554
		555	eval qq{
		556	sub $urxvt::term::proxy::AUTOLOAD {
		557	my \$proxy = shift;
		558	\$proxy->{term}->$1 (\@_)
		559	}
		560	1
		561	} or die "FATAL: unable to compile method forwarder: $@";
		562
		563	goto &$urxvt::term::proxy::AUTOLOAD;
		564	}
		565
		566	sub urxvt::destroy_hook::DESTROY {
		567	${$_[0]}->();
		568	}
		569
		570	sub urxvt::destroy_hook(&) {
		571	bless \shift, urxvt::destroy_hook::
		572	}
233		573
234	=head2 The C<urxvt::term> Class	574	=head2 The C<urxvt::term> Class
235		575
236	=over 4	576	=over 4
		577
		578	=item $term->destroy
		579
		580	Destroy the terminal object (close the window, free resources etc.).
		581
		582	=item $isset = $term->option ($optval[, $set])
		583
		584	Returns true if the option specified by C<$optval> is enabled, and
		585	optionally change it. All option values are stored by name in the hash
		586	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		587
		588	Here is a a likely non-exhaustive list of option names, please see the
		589	source file F</src/optinc.h> to see the actual list:
		590
		591	borderLess console cursorBlink cursorUnderline hold iconic insecure
		592	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		593	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		594	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		595	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		596	tripleclickwords utmpInhibit visualBell
237		597
238	=item $value = $term->resource ($name[, $newval])	598	=item $value = $term->resource ($name[, $newval])
239		599
240	Returns the current resource value associated with a given name and	600	Returns the current resource value associated with a given name and
241	optionally sets a new value. Setting values is most useful in the C<init>	601	optionally sets a new value. Setting values is most useful in the C<init>
…		…
251		611
252	Please note that resource strings will currently only be freed when the	612	Please note that resource strings will currently only be freed when the
253	terminal is destroyed, so changing options frequently will eat memory.	613	terminal is destroyed, so changing options frequently will eat memory.
254		614
255	Here is a a likely non-exhaustive list of resource names, not all of which	615	Here is a a likely non-exhaustive list of resource names, not all of which
256	are supported in every build, please see the source to see the actual	616	are supported in every build, please see the source file F</src/rsinc.h>
257	list:	617	to see the actual list:
258		618
259	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	619	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
260	borderLess color cursorBlink cursorUnderline cutchars delete_key	620	borderLess color cursorBlink cursorUnderline cutchars delete_key
261	display_name embed ext_bwidth fade font geometry hold iconName	621	display_name embed ext_bwidth fade font geometry hold iconName
262	imFont imLocale inputMethod insecure int_bwidth intensityStyles	622	imFont imLocale inputMethod insecure int_bwidth intensityStyles
263	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	623	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
264	modifier mouseWheelScrollPage name pastableTabs path pointerBlank	624	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
265	pointerBlankDelay preeditType print_pipe pty_fd reverseVideo saveLines	625	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
266	scrollBar scrollBar_align scrollBar_floating scrollBar_right	626	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
267	scrollBar_thickness scrollTtyKeypress scrollTtyOutput scrollWithBuffer	627	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
268	scrollstyle secondaryScreen secondaryScroll selectstyle shade term_name	628	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
269	title transparent transparent_all tripleclickwords utmpInhibit	629	shade term_name title transparent transparent_all tripleclickwords
270	visualBell	630	utmpInhibit visualBell
271		631
272	=cut	632	=cut
273		633
274	sub urxvt::term::resource($$;$) {	634	sub urxvt::term::resource($$;$) {
275	my ($self, $name) = (shift, shift);	635	my ($self, $name) = (shift, shift);
276	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	636	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
277	goto &urxvt::term::_resource;	637	&urxvt::term::_resource
278	}	638	}
		639
		640	=item $rend = $term->rstyle ([$new_rstyle])
		641
		642	Return and optionally change the current rendition. Text that is output by
		643	the terminal application will use this style.
		644
		645	=item ($row, $col) = $term->screen_cur ([$row, $col])
		646
		647	Return the current coordinates of the text cursor position and optionally
		648	set it (which is usually bad as applications don't expect that).
279		649
280	=item ($row, $col) = $term->selection_mark ([$row, $col])	650	=item ($row, $col) = $term->selection_mark ([$row, $col])
281		651
282	=item ($row, $col) = $term->selection_beg ([$row, $col])	652	=item ($row, $col) = $term->selection_beg ([$row, $col])
283		653
…		…
293		663
294	=item $oldtext = $term->selection ([$newtext])	664	=item $oldtext = $term->selection ([$newtext])
295		665
296	Return the current selection text and optionally replace it by C<$newtext>.	666	Return the current selection text and optionally replace it by C<$newtext>.
297		667
298	=item $term->scr_overlay ($x, $y, $text)	668	#=item $term->overlay ($x, $y, $text)
299		669	#
300	Create a simple multi-line overlay box. See the next method for details.	670	#Create a simple multi-line overlay box. See the next method for details.
		671	#
		672	#=cut
		673	#
		674	#sub urxvt::term::scr_overlay {
		675	# my ($self, $x, $y, $text) = @_;
		676	#
		677	# my @lines = split /\n/, $text;
		678	#
		679	# my $w = 0;
		680	# for (map $self->strwidth ($_), @lines) {
		681	# $w = $_ if $w < $_;
		682	# }
		683	#
		684	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
		685	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
		686	#}
		687
		688	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
		689
		690	Create a new (empty) overlay at the given position with the given
		691	width/height. C<$rstyle> defines the initial rendition style
		692	(default: C<OVERLAY_RSTYLE>).
		693
		694	If C<$border> is C<2> (default), then a decorative border will be put
		695	around the box.
		696
		697	If either C<$x> or C<$y> is negative, then this is counted from the
		698	right/bottom side, respectively.
		699
		700	This method returns an urxvt::overlay object. The overlay will be visible
		701	as long as the perl object is referenced.
		702
		703	The methods currently supported on C<urxvt::overlay> objects are:
		704
		705	=over 4
		706
		707	=item $overlay->set ($x, $y, $text, $rend)
		708
		709	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		710	text in rxvt-unicode's special encoding and an array of rendition values
		711	at a specific position inside the overlay.
		712
		713	=item $overlay->hide
		714
		715	If visible, hide the overlay, but do not destroy it.
		716
		717	=item $overlay->show
		718
		719	If hidden, display the overlay again.
		720
		721	=back
		722
		723	=item $popup = $term->popup ($event)
		724
		725	Creates a new C<urxvt::popup> object that implements a popup menu. The
		726	C<$event> I<must> be the event causing the menu to pop up (a button event,
		727	currently).
301		728
302	=cut	729	=cut
303		730
304	sub urxvt::term::scr_overlay {	731	sub urxvt::term::popup {
305	my ($self, $x, $y, $text) = @_;	732	my ($self, $event) = @_;
306		733
307	my @lines = split /\n/, $text;	734	$self->grab ($event->{time}, 1)
		735	or return;
308		736
309	my $w = 0;	737	my $popup = bless {
310	for (map urxvt::wcswidth $_, @lines) {	738	term => $self,
311	$w = $_ if $w < $_;	739	event => $event,
		740	}, urxvt::popup::;
		741
		742	Scalar::Util::weaken $popup->{term};
		743
		744	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		745	Scalar::Util::weaken $self->{_destroy}{$popup};
		746
		747	$popup
		748	}
		749
		750	=item $cellwidth = $term->strwidth ($string)
		751
		752	Returns the number of screen-cells this string would need. Correctly
		753	accounts for wide and combining characters.
		754
		755	=item $octets = $term->locale_encode ($string)
		756
		757	Convert the given text string into the corresponding locale encoding.
		758
		759	=item $string = $term->locale_decode ($octets)
		760
		761	Convert the given locale-encoded octets into a perl string.
		762
		763	=item $term->scr_add_lines ($string)
		764
		765	Write the given text string to the screen, as if output by the application
		766	running inside the terminal. It may not contain command sequences (escape
		767	codes), but is free to use line feeds, carriage returns and tabs. The
		768	string is a normal text string, not in locale-dependent encoding.
		769
		770	Normally its not a good idea to use this function, as programs might be
		771	confused by changes in cursor position or scrolling. Its useful inside a
		772	C<on_add_lines> hook, though.
		773
		774	=item $term->cmd_parse ($octets)
		775
		776	Similar to C<scr_add_lines>, but the argument must be in the
		777	locale-specific encoding of the terminal and can contain command sequences
		778	(escape codes) that will be interpreted.
		779
		780	=item $term->tt_write ($octets)
		781
		782	Write the octets given in C<$data> to the tty (i.e. as program input). To
		783	pass characters instead of octets, you should convert your strings first
		784	to the locale-specific encoding using C<< $term->locale_encode >>.
		785
		786	=item $windowid = $term->parent
		787
		788	Return the window id of the toplevel window.
		789
		790	=item $windowid = $term->vt
		791
		792	Return the window id of the terminal window.
		793
		794	=item $window_width = $term->width
		795
		796	=item $window_height = $term->height
		797
		798	=item $font_width = $term->fwidth
		799
		800	=item $font_height = $term->fheight
		801
		802	=item $font_ascent = $term->fbase
		803
		804	=item $terminal_rows = $term->nrow
		805
		806	=item $terminal_columns = $term->ncol
		807
		808	=item $has_focus = $term->focus
		809
		810	=item $is_mapped = $term->mapped
		811
		812	=item $max_scrollback = $term->saveLines
		813
		814	=item $nrow_plus_saveLines = $term->total_rows
		815
		816	=item $lines_in_scrollback = $term->nsaved
		817
		818	Return various integers describing terminal characteristics.
		819
		820	=item $modifiermask = $term->ModLevel3Mask
		821
		822	=item $modifiermask = $term->ModMetaMask
		823
		824	=item $modifiermask = $term->ModNumLockMask
		825
		826	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		827	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		828
		829	=item $view_start = $term->view_start ([$newvalue])
		830
		831	Returns the negative row number of the topmost line. Minimum value is
		832	C<0>, which displays the normal terminal contents. Larger values scroll
		833	this many lines into the scrollback buffer.
		834
		835	=item $term->want_refresh
		836
		837	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		838	compare the on-screen display with its stored representation. If they
		839	differ, it redraws the differences.
		840
		841	Used after changing terminal contents to display them.
		842
		843	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		844
		845	Returns the text of the entire row with number C<$row_number>. Row C<0>
		846	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		847	terminal line. The scrollback buffer starts at line C<-1> and extends to
		848	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		849	is requested.
		850
		851	If C<$new_text> is specified, it will replace characters in the current
		852	line, starting at column C<$start_col> (default C<0>), which is useful
		853	to replace only parts of a line. The font index in the rendition will
		854	automatically be updated.
		855
		856	C<$text> is in a special encoding: tabs and wide characters that use more
		857	than one cell when displayed are padded with urxvt::NOCHAR characters
		858	(C<chr 65535>). Characters with combining characters and other characters
		859	that do not fit into the normal tetx encoding will be replaced with
		860	characters in the private use area.
		861
		862	You have to obey this encoding when changing text. The advantage is
		863	that C<substr> and similar functions work on screen cells and not on
		864	characters.
		865
		866	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		867	can be used to convert normal strings into this encoding and vice versa.
		868
		869	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		870
		871	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		872	bitsets. Rendition bitsets contain information about colour, font, font
		873	styles and similar information. See also C<< $term->ROW_t >>.
		874
		875	When setting rendition, the font mask will be ignored.
		876
		877	See the section on RENDITION, above.
		878
		879	=item $length = $term->ROW_l ($row_number[, $new_length])
		880
		881	Returns the number of screen cells that are in use ("the line
		882	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		883	line is joined with the following one.
		884
		885	=item $bool = $term->is_longer ($row_number)
		886
		887	Returns true if the row is part of a multiple-row logical "line" (i.e.
		888	joined with the following row), which means all characters are in use
		889	and it is continued on the next row (and possibly a continuation of the
		890	previous row(s)).
		891
		892	=item $line = $term->line ($row_number)
		893
		894	Create and return a new C<urxvt::line> object that stores information
		895	about the logical line that row C<$row_number> is part of. It supports the
		896	following methods:
		897
		898	=over 4
		899
		900	=item $text = $line->t ([$new_text])
		901
		902	Returns or replaces the full text of the line, similar to C<ROW_t>
		903
		904	=item $rend = $line->r ([$new_rend])
		905
		906	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		907
		908	=item $length = $line->l
		909
		910	Returns the length of the line in cells, similar to C<ROW_l>.
		911
		912	=item $rownum = $line->beg
		913
		914	=item $rownum = $line->end
		915
		916	Return the row number of the first/last row of the line, respectively.
		917
		918	=item $offset = $line->offset_of ($row, $col)
		919
		920	Returns the character offset of the given row\|col pair within the logical
		921	line.
		922
		923	=item ($row, $col) = $line->coord_of ($offset)
		924
		925	Translates a string offset into terminal coordinates again.
		926
		927	=back
		928
		929	=cut
		930
		931	sub urxvt::term::line {
		932	my ($self, $row) = @_;
		933
		934	my $maxrow = $self->nrow - 1;
		935
		936	my ($beg, $end) = ($row, $row);
		937
		938	--$beg while $self->ROW_is_longer ($beg - 1);
		939	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		940
		941	bless {
		942	term => $self,
		943	beg => $beg,
		944	end => $end,
		945	ncol => $self->ncol,
		946	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		947	}, urxvt::line::
		948	}
		949
		950	sub urxvt::line::t {
		951	my ($self) = @_;
		952
		953	if (@_ > 1)
		954	{
		955	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		956	for $self->{beg} .. $self->{end};
		957	}
		958
		959	defined wantarray &&
		960	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		961	0, $self->{len}
		962	}
		963
		964	sub urxvt::line::r {
		965	my ($self) = @_;
		966
		967	if (@_ > 1)
		968	{
		969	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		970	for $self->{beg} .. $self->{end};
		971	}
		972
		973	if (defined wantarray) {
		974	my $rend = [
		975	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		976	];
		977	$#$rend = $self->{len} - 1;
		978	return $rend;
312	}	979	}
313		980
314	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	981	()
315	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
316	}	982	}
317		983
318	=item $term->scr_overlay_new ($x, $y, $width, $height)	984	sub urxvt::line::beg { $_[0]{beg} }
		985	sub urxvt::line::end { $_[0]{end} }
		986	sub urxvt::line::l { $_[0]{len} }
319		987
320	Create a new (empty) overlay at the given position with the given	988	sub urxvt::line::offset_of {
321	width/height. A border will be put around the box. If either C<$x> or	989	my ($self, $row, $col) = @_;
322	C<$y> is negative, then this is counted from the right/bottom side,
323	respectively.
324		990
325	=item $term->scr_overlay_off	991	($row - $self->{beg}) * $self->{ncol} + $col
		992	}
326		993
327	Switch the overlay off again.	994	sub urxvt::line::coord_of {
		995	my ($self, $offset) = @_;
328		996
329	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	997	use integer;
330		998
331	Put a single character (specified numerically) at the given overlay	999	(
332	position.	1000	$offset / $self->{ncol} + $self->{beg},
		1001	$offset % $self->{ncol}
		1002	)
		1003	}
333		1004
334	=item $term->scr_overlay_set ($x, $y, $text)	1005	=item ($row, $col) = $line->coord_of ($offset)
		1006	=item $text = $term->special_encode $string
335		1007
336	Write a string at the given position into the overlay.	1008	Converts a perl string into the special encoding used by rxvt-unicode,
		1009	where one character corresponds to one screen cell. See
		1010	C<< $term->ROW_t >> for details.
		1011
		1012	=item $string = $term->special_decode $text
		1013
		1014	Converts rxvt-unicodes text reprsentation into a perl string. See
		1015	C<< $term->ROW_t >> for details.
337		1016
338	=back	1017	=back
		1018
		1019	=head2 The C<urxvt::popup> Class
		1020
		1021	=over 4
		1022
		1023	=cut
		1024
		1025	package urxvt::popup;
		1026
		1027	sub add_item {
		1028	my ($self, $item) = @_;
		1029
		1030	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1031	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1032	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1033
		1034	$item->{render} \|\|= sub { $_[0]{text} };
		1035
		1036	push @{ $self->{item} }, $item;
		1037	}
		1038
		1039	sub add_separator {
		1040	my ($self, $sep) = @_;
		1041
		1042	$sep \|\|= "═";
		1043
		1044	$self->add_item ({
		1045	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1046	text => "",
		1047	render => sub { $sep x $urxvt::TERM->ncol },
		1048	activate => sub { },
		1049	});
		1050	}
		1051
		1052	sub add_title {
		1053	my ($self, $title) = @_;
		1054
		1055	$self->add_item ({
		1056	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1057	text => $title,
		1058	activate => sub { },
		1059	});
		1060	}
		1061
		1062	sub add_button {
		1063	my ($self, $text, $cb) = @_;
		1064
		1065	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1066	}
		1067
		1068	sub add_toggle {
		1069	my ($self, $text, $cb, $value) = @_;
		1070
		1071	my $item; $item = {
		1072	type => "button",
		1073	text => " $text",
		1074	value => $value,
		1075	render => sub { ($item->{value} ? "* " : " ") . $text },
		1076	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1077	};
		1078
		1079	$self->add_item ($item);
		1080	}
		1081
		1082	sub show {
		1083	my ($self) = @_;
		1084
		1085	local $urxvt::popup::self = $self;
		1086
		1087	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1088	"--transient-for" => $self->{term}->parent,
		1089	"-pe" => "urxvt-popup")
		1090	or die "unable to create popup window\n";
		1091	}
		1092
		1093	sub DESTROY {
		1094	my ($self) = @_;
		1095
		1096	$self->{term}->ungrab;
		1097	}
339		1098
340	=head2 The C<urxvt::timer> Class	1099	=head2 The C<urxvt::timer> Class
341		1100
342	This class implements timer watchers/events. Time is represented as a	1101	This class implements timer watchers/events. Time is represented as a
343	fractional number of seconds since the epoch. Example:	1102	fractional number of seconds since the epoch. Example:
344		1103
345	# create a digital clock display in upper right corner	1104	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
346	$term->{timer} = urxvt::timer	1105	$term->{timer} = urxvt::timer
347	->new	1106	->new
348	->start (urxvt::NOW)	1107	->interval (1)
349	->cb (sub {	1108	->cb (sub {
350	my ($timer) = @_;
351	my $time = $timer->at;
352	$timer->start ($time + 1);
353	$self->scr_overlay (-1, 0,	1109	$term->{overlay}->set (0, 0,
354	POSIX::strftime "%H:%M:%S", localtime $time);	1110	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
355	});	1111	});
356		1112
357	=over 4	1113	=over 4
358		1114
359	=item $timer = new urxvt::timer	1115	=item $timer = new urxvt::timer
360		1116
361	Create a new timer object in stopped state.	1117	Create a new timer object in started state. It is scheduled to fire
		1118	immediately.
362		1119
363	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1120	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
364		1121
365	Set the callback to be called when the timer triggers.	1122	Set the callback to be called when the timer triggers.
366		1123
…		…
369	Return the time this watcher will fire next.	1126	Return the time this watcher will fire next.
370		1127
371	=item $timer = $timer->set ($tstamp)	1128	=item $timer = $timer->set ($tstamp)
372		1129
373	Set the time the event is generated to $tstamp.	1130	Set the time the event is generated to $tstamp.
		1131
		1132	=item $timer = $timer->interval ($interval)
		1133
		1134	Normally (and when C<$interval> is C<0>), the timer will automatically
		1135	stop after it has fired once. If C<$interval> is non-zero, then the timer
		1136	is automatically rescheduled at the given intervals.
374		1137
375	=item $timer = $timer->start	1138	=item $timer = $timer->start
376		1139
377	Start the timer.	1140	Start the timer.
378		1141
…		…
441	This variable controls the verbosity level of the perl extension. Higher	1204	This variable controls the verbosity level of the perl extension. Higher
442	numbers indicate more verbose output.	1205	numbers indicate more verbose output.
443		1206
444	=over 4	1207	=over 4
445		1208
446	=item 0 - only fatal messages	1209	=item =0 - only fatal messages
447		1210
448	=item 3 - script loading and management	1211	=item =3 - script loading and management
449		1212
450	=item 10 - all events received	1213	=item =10 - all events received
451		1214
452	=back	1215	=back
453		1216
454	=head1 AUTHOR	1217	=head1 AUTHOR
455		1218

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.5 by root, Mon Jan 2 17:20:00 2006 UTC vs. Revision 1.53 by root, Sun Jan 8 01:16:09 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.5 by root, Mon Jan 2 17:20:00 2006 UTC vs.
Revision 1.53 by root, Sun Jan 8 01:16:09 2006 UTC