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

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.54 by root, Sun Jan 8 01:59:29 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.54 by root, Sun Jan 8 01:59:29 2006 UTC