[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.55 by root, Sun Jan 8 05:50:27 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
22		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
23	=head2 Hooks	124	=head2 Hooks
24		125
25	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
26	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.
27		135
28	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
29	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,
30	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.
31		139
34	=over 4	142	=over 4
35		143
36	=item on_init $term	144	=item on_init $term
37		145
38	Called after a new terminal object has been initialized, but before	146	Called after a new terminal object has been initialized, but before
39	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.
40		151
41	=item on_reset $term	152	=item on_reset $term
42		153
43	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
44	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
…		…
64	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
65	by calling C<< $term->selection >>.	176	by calling C<< $term->selection >>.
66		177
67	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.
68		179
69	=item on_focus_in $term	180	=item on_sel_extend $term
70		181
71	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
72	focus in processing.	183	click) and is either supposed to return false (normal operation), or
73		184	should extend the selection itelf and return true to suppress the built-in
74	=item on_focus_out $term
75
76	Called wheneever the window loses keyboard focus, before urxvt does focus
77	out processing.	185	processing.
		186
		187	See the F<selection> example extension.
78		188
79	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
80		190
81	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
82	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
93	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
94		204
95	=item on_tty_activity $term NYI	205	=item on_tty_activity $term NYI
96		206
97	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.
98		243
99	=item on_refresh_begin $term	244	=item on_refresh_begin $term
100		245
101	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
102	or similar effects by modify terminal contents in refresh_begin, and	247	or similar effects by modify terminal contents in refresh_begin, and
…		…
105		250
106	=item on_refresh_end $term	251	=item on_refresh_end $term
107		252
108	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>.
109		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
110	=back	297	=back
111		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
112	=head2 Functions in the C<urxvt> Package	310	=head2 Functions in the C<urxvt> Package
113		311
114	=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.
115		321
116	=item urxvt::fatal $errormessage	322	=item urxvt::fatal $errormessage
117		323
118	Fatally aborts execution with the given error message. Avoid at all	324	Fatally aborts execution with the given error message. Avoid at all
119	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
120	starts up.	326	starts up.
121		327
122	=item urxvt::warn $string	328	=item urxvt::warn $string
123		329
124	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
125	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
126	that calls this function.	332	that calls this function.
127		333
128	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
129	correct place, e.g. on stderr of the connecting urxvtc client.	335	correct place, e.g. on stderr of the connecting urxvtc client.
130		336
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	337	=item $time = urxvt::NOW
137		338
138	Returns the "current time" (as per the event loop).	339	Returns the "current time" (as per the event loop).
139		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 calls and event processing.
		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
140	=cut	403	=cut
141		404
142	package urxvt;	405	package urxvt;
143		406
		407	use utf8;
144	use strict;	408	use strict;
		409	use Scalar::Util ();
		410	use List::Util ();
145		411
146	our $term;	412	our $VERSION = 1;
		413	our $TERM;
147	our @HOOKNAME;	414	our @HOOKNAME;
		415	our %OPTION;
148	our $LIBDIR;	416	our $LIBDIR;
149		417
150	BEGIN {	418	BEGIN {
151	urxvt->bootstrap;	419	urxvt->bootstrap;
152		420
…		…
157	unless $msg =~ /\n$/;	425	unless $msg =~ /\n$/;
158	urxvt::warn ($msg);	426	urxvt::warn ($msg);
159	};	427	};
160	}	428	}
161		429
		430	my @hook_count;
162	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	431	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
163		432
164	sub verbose {	433	sub verbose {
165	my ($level, $msg) = @_;	434	my ($level, $msg) = @_;
166	warn "$msg\n"; #d#	435	warn "$msg\n" if $level <= $verbosity;
167	}
168
169	my @invoke_cb;
170
171	# called by the rxvt core
172	sub invoke {
173	local $term = shift;
174	my $htype = shift;
175
176	my $cb = $invoke_cb[$htype];
177
178	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
179	if $verbosity >= 10;
180
181	while (my ($k, $v) = each %$cb) {
182	return 1 if $v->($term, @_);
183	}
184
185	0
186	}	436	}
187		437
188	# find on_xxx subs in the package and register them	438	# find on_xxx subs in the package and register them
189	# as hooks	439	# as hooks
190	sub register_package($) {	440	sub register_package($) {
191	my ($pkg) = @_;	441	my ($pkg) = @_;
192		442
193	for my $hook (0.. $#HOOKNAME) {	443	for my $htype (0.. $#HOOKNAME) {
194	my $name = $HOOKNAME[$hook];	444	my $name = $HOOKNAME[$htype];
195		445
196	my $ref = $pkg->can ("on_" . lc $name)	446	my $ref = $pkg->can ("on_" . lc $name)
197	or next;	447	or next;
198		448
199	$invoke_cb[$hook]{$ref*1} = $ref;	449	$TERM->{_hook}[$htype]{$pkg} = $ref;
		450	$hook_count[$htype]++
200	set_should_invoke $hook, 1;	451	or set_should_invoke $htype, 1;
201	}	452	}
202	}	453	}
203		454
204	my $script_pkg = "script0000";	455	my $extension_pkg = "extension0000";
205	my %script_pkg;	456	my %extension_pkg;
206		457
207	# load a single script into its own package, once only	458	# load a single script into its own package, once only
208	sub load_script($) {	459	sub extension_package($) {
209	my ($path) = @_;	460	my ($path) = @_;
210		461
211	$script_pkg{$path} \|\|= do {	462	$extension_pkg{$path} \|\|= do {
212	my $pkg = $script_pkg++;	463	my $pkg = "urxvt::" . ($extension_pkg++);
		464
213	verbose 3, "loading script '$path' into package '$pkg'";	465	verbose 3, "loading extension '$path' into package '$pkg'";
214		466
215	open my $fh, "<:raw", $path	467	open my $fh, "<:raw", $path
216	or die "$path: $!";	468	or die "$path: $!";
217		469
218	eval "package $pkg; use strict; use utf8;\n"	470	my $source = "package $pkg; use strict; use utf8;\n"
		471	. "use base urxvt::term::proxy::;\n"
219	. "#line 1 \"$path\"\n"	472	. "#line 1 \"$path\"\n{\n"
220	. do { local $/; <$fh> }	473	. (do { local $/; <$fh> })
		474	. "\n};\n1";
		475
221	or die "$path: $@";	476	eval $source or die "$path: $@";
222
223	register_package $pkg;
224		477
225	$pkg	478	$pkg
226	};	479	}
227	}	480	}
228		481
229	load_script $_ for grep -f $_, <$LIBDIR/perl-init/*>;	482	our $retval; # return value for urxvt
230		483
		484	# called by the rxvt core
		485	sub invoke {
		486	local $TERM = shift;
		487	my $htype = shift;
231		488
232	=back	489	if ($htype == 0) { # INIT
		490	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		491
		492	my %want_ext;
		493
		494	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		495	if ($_ eq "default") {
		496	$want_ext{$_}++ for qw(selection option-popup);
		497	} elsif (/^-(.*)$/) {
		498	delete $want_ext{$1};
		499	} else {
		500	$want_ext{$_}++;
		501	}
		502	}
		503
		504	for my $ext (keys %want_ext) {
		505	my @files = grep -f $_, map "$_/$ext", @dirs;
		506
		507	if (@files) {
		508	register_package extension_package $files[0];
		509	} else {
		510	warn "perl extension '$ext' not found in perl library search path\n";
		511	}
		512	}
		513
		514	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		515	warn $@ if $@;
		516	}
		517
		518	$retval = undef;
		519
		520	if (my $cb = $TERM->{_hook}[$htype]) {
		521	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		522	if $verbosity >= 10;
		523
		524	keys %$cb;
		525
		526	while (my ($pkg, $cb) = each %$cb) {
		527	eval {
		528	$retval = $cb->(
		529	$TERM->{_pkg}{$pkg} \|\|= do {
		530	my $proxy = bless { }, $pkg;
		531	Scalar::Util::weaken ($proxy->{term} = $TERM);
		532	$proxy
		533	},
		534	@_,
		535	) and last;
		536	};
		537	warn $@ if $@;#d#
		538	}
		539	}
		540
		541	if ($htype == 1) { # DESTROY
		542	# remove hooks if unused
		543	if (my $hook = $TERM->{_hook}) {
		544	for my $htype (0..$#$hook) {
		545	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		546	or set_should_invoke $htype, 0;
		547	}
		548	}
		549
		550	# clear package objects
		551	%$_ = () for values %{ $TERM->{_pkg} };
		552
		553	# clear package
		554	%$TERM = ();
		555	}
		556
		557	$retval
		558	}
		559
		560	# urxvt::term::proxy
		561
		562	sub urxvt::term::proxy::AUTOLOAD {
		563	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		564	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		565
		566	eval qq{
		567	sub $urxvt::term::proxy::AUTOLOAD {
		568	my \$proxy = shift;
		569	\$proxy->{term}->$1 (\@_)
		570	}
		571	1
		572	} or die "FATAL: unable to compile method forwarder: $@";
		573
		574	goto &$urxvt::term::proxy::AUTOLOAD;
		575	}
		576
		577	# urxvt::destroy_hook
		578
		579	sub urxvt::destroy_hook::DESTROY {
		580	${$_[0]}->();
		581	}
		582
		583	sub urxvt::destroy_hook(&) {
		584	bless \shift, urxvt::destroy_hook::
		585	}
		586
		587	# urxvt::anyevent
		588
		589	package urxvt::anyevent;
		590
		591	our $VERSION = 1;
		592
		593	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		594	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		595
		596	sub timer {
		597	my ($class, %arg) = @_;
		598
		599	my $cb = $arg{cb};
		600
		601	urxvt::timer
		602	->new
		603	->start (urxvt::NOW + $arg{after})
		604	->cb (sub {
		605	$_[0]->stop; # need to cancel manually
		606	$cb->();
		607	})
		608	}
		609
		610	sub io {
		611	my ($class, %arg) = @_;
		612
		613	my $cb = $arg{cb};
		614
		615	bless [$arg{fh}, urxvt::iow
		616	->new
		617	->fd (fileno $arg{fh})
		618	->events (($arg{poll} =~ /r/ ? 1 : 0)
		619	\| ($arg{poll} =~ /w/ ? 2 : 0))
		620	->start
		621	->cb (sub {
		622	$cb->(($_[1] & 1 ? 'r' : '')
		623	. ($_[1] & 2 ? 'w' : ''));
		624	})],
		625	urxvt::anyevent::
		626	}
		627
		628	sub DESTROY {
		629	$_[0][1]->stop;
		630	}
		631
		632	sub condvar {
		633	bless \my $flag, urxvt::anyevent::condvar::
		634	}
		635
		636	sub urxvt::anyevent::condvar::broadcast {
		637	${$_[0]}++;
		638	}
		639
		640	sub urxvt::anyevent::condvar::wait {
		641	unless (${$_[0]}) {
		642	require Carp;
		643	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		644	}
		645	}
		646
		647	package urxvt::term;
233		648
234	=head2 The C<urxvt::term> Class	649	=head2 The C<urxvt::term> Class
235		650
236	=over 4	651	=over 4
		652
		653	=item $term->destroy
		654
		655	Destroy the terminal object (close the window, free resources etc.).
		656
		657	=item $isset = $term->option ($optval[, $set])
		658
		659	Returns true if the option specified by C<$optval> is enabled, and
		660	optionally change it. All option values are stored by name in the hash
		661	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		662
		663	Here is a a likely non-exhaustive list of option names, please see the
		664	source file F</src/optinc.h> to see the actual list:
		665
		666	borderLess console cursorBlink cursorUnderline hold iconic insecure
		667	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		668	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		669	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		670	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		671	tripleclickwords utmpInhibit visualBell
		672
		673	=item $value = $term->resource ($name[, $newval])
		674
		675	Returns the current resource value associated with a given name and
		676	optionally sets a new value. Setting values is most useful in the C<init>
		677	hook. Unset resources are returned and accepted as C<undef>.
		678
		679	The new value must be properly encoded to a suitable character encoding
		680	before passing it to this method. Similarly, the returned value may need
		681	to be converted from the used encoding to text.
		682
		683	Resource names are as defined in F<src/rsinc.h>. Colours can be specified
		684	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
		685	likely change).
		686
		687	Please note that resource strings will currently only be freed when the
		688	terminal is destroyed, so changing options frequently will eat memory.
		689
		690	Here is a a likely non-exhaustive list of resource names, not all of which
		691	are supported in every build, please see the source file F</src/rsinc.h>
		692	to see the actual list:
		693
		694	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
		695	borderLess color cursorBlink cursorUnderline cutchars delete_key
		696	display_name embed ext_bwidth fade font geometry hold iconName
		697	imFont imLocale inputMethod insecure int_bwidth intensityStyles
		698	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
		699	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
		700	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
		701	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
		702	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
		703	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
		704	shade term_name title transparent transparent_all tripleclickwords
		705	utmpInhibit visualBell
		706
		707	=cut
		708
		709	sub resource($$;$) {
		710	my ($self, $name) = (shift, shift);
		711	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
		712	&urxvt::term::_resource
		713	}
		714
		715	=item $rend = $term->rstyle ([$new_rstyle])
		716
		717	Return and optionally change the current rendition. Text that is output by
		718	the terminal application will use this style.
		719
		720	=item ($row, $col) = $term->screen_cur ([$row, $col])
		721
		722	Return the current coordinates of the text cursor position and optionally
		723	set it (which is usually bad as applications don't expect that).
237		724
238	=item ($row, $col) = $term->selection_mark ([$row, $col])	725	=item ($row, $col) = $term->selection_mark ([$row, $col])
239		726
240	=item ($row, $col) = $term->selection_beg ([$row, $col])	727	=item ($row, $col) = $term->selection_beg ([$row, $col])
241		728
…		…
251		738
252	=item $oldtext = $term->selection ([$newtext])	739	=item $oldtext = $term->selection ([$newtext])
253		740
254	Return the current selection text and optionally replace it by C<$newtext>.	741	Return the current selection text and optionally replace it by C<$newtext>.
255		742
256	=item $term->scr_overlay ($x, $y, $text)	743	#=item $term->overlay ($x, $y, $text)
257		744	#
258	Create a simple multi-line overlay box. See the next method for details.	745	#Create a simple multi-line overlay box. See the next method for details.
		746	#
		747	#=cut
		748	#
		749	#sub urxvt::term::scr_overlay {
		750	# my ($self, $x, $y, $text) = @_;
		751	#
		752	# my @lines = split /\n/, $text;
		753	#
		754	# my $w = 0;
		755	# for (map $self->strwidth ($_), @lines) {
		756	# $w = $_ if $w < $_;
		757	# }
		758	#
		759	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
		760	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
		761	#}
		762
		763	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
		764
		765	Create a new (empty) overlay at the given position with the given
		766	width/height. C<$rstyle> defines the initial rendition style
		767	(default: C<OVERLAY_RSTYLE>).
		768
		769	If C<$border> is C<2> (default), then a decorative border will be put
		770	around the box.
		771
		772	If either C<$x> or C<$y> is negative, then this is counted from the
		773	right/bottom side, respectively.
		774
		775	This method returns an urxvt::overlay object. The overlay will be visible
		776	as long as the perl object is referenced.
		777
		778	The methods currently supported on C<urxvt::overlay> objects are:
		779
		780	=over 4
		781
		782	=item $overlay->set ($x, $y, $text, $rend)
		783
		784	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		785	text in rxvt-unicode's special encoding and an array of rendition values
		786	at a specific position inside the overlay.
		787
		788	=item $overlay->hide
		789
		790	If visible, hide the overlay, but do not destroy it.
		791
		792	=item $overlay->show
		793
		794	If hidden, display the overlay again.
		795
		796	=back
		797
		798	=item $popup = $term->popup ($event)
		799
		800	Creates a new C<urxvt::popup> object that implements a popup menu. The
		801	C<$event> I<must> be the event causing the menu to pop up (a button event,
		802	currently).
259		803
260	=cut	804	=cut
261		805
262	sub urxvt::term::scr_overlay {	806	sub popup {
263	my ($self, $x, $y, $text) = @_;	807	my ($self, $event) = @_;
264		808
265	my @lines = split /\n/, $text;	809	$self->grab ($event->{time}, 1)
		810	or return;
266		811
267	my $w = 0;	812	my $popup = bless {
268	for (map urxvt::wcswidth $_, @lines) {	813	term => $self,
269	$w = $_ if $w < $_;	814	event => $event,
		815	}, urxvt::popup::;
		816
		817	Scalar::Util::weaken $popup->{term};
		818
		819	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		820	Scalar::Util::weaken $self->{_destroy}{$popup};
		821
		822	$popup
		823	}
		824
		825	=item $cellwidth = $term->strwidth ($string)
		826
		827	Returns the number of screen-cells this string would need. Correctly
		828	accounts for wide and combining characters.
		829
		830	=item $octets = $term->locale_encode ($string)
		831
		832	Convert the given text string into the corresponding locale encoding.
		833
		834	=item $string = $term->locale_decode ($octets)
		835
		836	Convert the given locale-encoded octets into a perl string.
		837
		838	=item $term->scr_add_lines ($string)
		839
		840	Write the given text string to the screen, as if output by the application
		841	running inside the terminal. It may not contain command sequences (escape
		842	codes), but is free to use line feeds, carriage returns and tabs. The
		843	string is a normal text string, not in locale-dependent encoding.
		844
		845	Normally its not a good idea to use this function, as programs might be
		846	confused by changes in cursor position or scrolling. Its useful inside a
		847	C<on_add_lines> hook, though.
		848
		849	=item $term->cmd_parse ($octets)
		850
		851	Similar to C<scr_add_lines>, but the argument must be in the
		852	locale-specific encoding of the terminal and can contain command sequences
		853	(escape codes) that will be interpreted.
		854
		855	=item $term->tt_write ($octets)
		856
		857	Write the octets given in C<$data> to the tty (i.e. as program input). To
		858	pass characters instead of octets, you should convert your strings first
		859	to the locale-specific encoding using C<< $term->locale_encode >>.
		860
		861	=item $windowid = $term->parent
		862
		863	Return the window id of the toplevel window.
		864
		865	=item $windowid = $term->vt
		866
		867	Return the window id of the terminal window.
		868
		869	=item $window_width = $term->width
		870
		871	=item $window_height = $term->height
		872
		873	=item $font_width = $term->fwidth
		874
		875	=item $font_height = $term->fheight
		876
		877	=item $font_ascent = $term->fbase
		878
		879	=item $terminal_rows = $term->nrow
		880
		881	=item $terminal_columns = $term->ncol
		882
		883	=item $has_focus = $term->focus
		884
		885	=item $is_mapped = $term->mapped
		886
		887	=item $max_scrollback = $term->saveLines
		888
		889	=item $nrow_plus_saveLines = $term->total_rows
		890
		891	=item $lines_in_scrollback = $term->nsaved
		892
		893	Return various integers describing terminal characteristics.
		894
		895	=item $modifiermask = $term->ModLevel3Mask
		896
		897	=item $modifiermask = $term->ModMetaMask
		898
		899	=item $modifiermask = $term->ModNumLockMask
		900
		901	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		902	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		903
		904	=item $view_start = $term->view_start ([$newvalue])
		905
		906	Returns the negative row number of the topmost line. Minimum value is
		907	C<0>, which displays the normal terminal contents. Larger values scroll
		908	this many lines into the scrollback buffer.
		909
		910	=item $term->want_refresh
		911
		912	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		913	compare the on-screen display with its stored representation. If they
		914	differ, it redraws the differences.
		915
		916	Used after changing terminal contents to display them.
		917
		918	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		919
		920	Returns the text of the entire row with number C<$row_number>. Row C<0>
		921	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		922	terminal line. The scrollback buffer starts at line C<-1> and extends to
		923	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		924	is requested.
		925
		926	If C<$new_text> is specified, it will replace characters in the current
		927	line, starting at column C<$start_col> (default C<0>), which is useful
		928	to replace only parts of a line. The font index in the rendition will
		929	automatically be updated.
		930
		931	C<$text> is in a special encoding: tabs and wide characters that use more
		932	than one cell when displayed are padded with urxvt::NOCHAR characters
		933	(C<chr 65535>). Characters with combining characters and other characters
		934	that do not fit into the normal tetx encoding will be replaced with
		935	characters in the private use area.
		936
		937	You have to obey this encoding when changing text. The advantage is
		938	that C<substr> and similar functions work on screen cells and not on
		939	characters.
		940
		941	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		942	can be used to convert normal strings into this encoding and vice versa.
		943
		944	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		945
		946	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		947	bitsets. Rendition bitsets contain information about colour, font, font
		948	styles and similar information. See also C<< $term->ROW_t >>.
		949
		950	When setting rendition, the font mask will be ignored.
		951
		952	See the section on RENDITION, above.
		953
		954	=item $length = $term->ROW_l ($row_number[, $new_length])
		955
		956	Returns the number of screen cells that are in use ("the line
		957	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		958	line is joined with the following one.
		959
		960	=item $bool = $term->is_longer ($row_number)
		961
		962	Returns true if the row is part of a multiple-row logical "line" (i.e.
		963	joined with the following row), which means all characters are in use
		964	and it is continued on the next row (and possibly a continuation of the
		965	previous row(s)).
		966
		967	=item $line = $term->line ($row_number)
		968
		969	Create and return a new C<urxvt::line> object that stores information
		970	about the logical line that row C<$row_number> is part of. It supports the
		971	following methods:
		972
		973	=over 4
		974
		975	=item $text = $line->t ([$new_text])
		976
		977	Returns or replaces the full text of the line, similar to C<ROW_t>
		978
		979	=item $rend = $line->r ([$new_rend])
		980
		981	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		982
		983	=item $length = $line->l
		984
		985	Returns the length of the line in cells, similar to C<ROW_l>.
		986
		987	=item $rownum = $line->beg
		988
		989	=item $rownum = $line->end
		990
		991	Return the row number of the first/last row of the line, respectively.
		992
		993	=item $offset = $line->offset_of ($row, $col)
		994
		995	Returns the character offset of the given row\|col pair within the logical
		996	line.
		997
		998	=item ($row, $col) = $line->coord_of ($offset)
		999
		1000	Translates a string offset into terminal coordinates again.
		1001
		1002	=back
		1003
		1004	=cut
		1005
		1006	sub line {
		1007	my ($self, $row) = @_;
		1008
		1009	my $maxrow = $self->nrow - 1;
		1010
		1011	my ($beg, $end) = ($row, $row);
		1012
		1013	--$beg while $self->ROW_is_longer ($beg - 1);
		1014	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1015
		1016	bless {
		1017	term => $self,
		1018	beg => $beg,
		1019	end => $end,
		1020	ncol => $self->ncol,
		1021	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1022	}, urxvt::line::
		1023	}
		1024
		1025	sub urxvt::line::t {
		1026	my ($self) = @_;
		1027
		1028	if (@_ > 1)
		1029	{
		1030	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1031	for $self->{beg} .. $self->{end};
		1032	}
		1033
		1034	defined wantarray &&
		1035	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1036	0, $self->{len}
		1037	}
		1038
		1039	sub urxvt::line::r {
		1040	my ($self) = @_;
		1041
		1042	if (@_ > 1)
		1043	{
		1044	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1045	for $self->{beg} .. $self->{end};
		1046	}
		1047
		1048	if (defined wantarray) {
		1049	my $rend = [
		1050	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1051	];
		1052	$#$rend = $self->{len} - 1;
		1053	return $rend;
270	}	1054	}
271		1055
272	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1056	()
273	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
274	}	1057	}
275		1058
276	=item $term->scr_overlay_new ($x, $y, $width, $height)	1059	sub urxvt::line::beg { $_[0]{beg} }
		1060	sub urxvt::line::end { $_[0]{end} }
		1061	sub urxvt::line::l { $_[0]{len} }
277		1062
278	Create a new (empty) overlay at the given position with the given	1063	sub urxvt::line::offset_of {
279	width/height. A border will be put around the box. If either C<$x> or	1064	my ($self, $row, $col) = @_;
280	C<$y> is negative, then this is counted from the right/bottom side,
281	respectively.
282		1065
283	=item $term->scr_overlay_off	1066	($row - $self->{beg}) * $self->{ncol} + $col
		1067	}
284		1068
285	Switch the overlay off again.	1069	sub urxvt::line::coord_of {
		1070	my ($self, $offset) = @_;
286		1071
287	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	1072	use integer;
288		1073
289	Put a single character (specified numerically) at the given overlay	1074	(
290	position.	1075	$offset / $self->{ncol} + $self->{beg},
		1076	$offset % $self->{ncol}
		1077	)
		1078	}
291		1079
292	=item $term->scr_overlay_set ($x, $y, $text)	1080	=item ($row, $col) = $line->coord_of ($offset)
		1081	=item $text = $term->special_encode $string
293		1082
294	Write a string at the given position into the overlay.	1083	Converts a perl string into the special encoding used by rxvt-unicode,
		1084	where one character corresponds to one screen cell. See
		1085	C<< $term->ROW_t >> for details.
		1086
		1087	=item $string = $term->special_decode $text
		1088
		1089	Converts rxvt-unicodes text reprsentation into a perl string. See
		1090	C<< $term->ROW_t >> for details.
295		1091
296	=back	1092	=back
		1093
		1094	=cut
		1095
		1096	package urxvt::popup;
		1097
		1098	=head2 The C<urxvt::popup> Class
		1099
		1100	=over 4
		1101
		1102	=cut
		1103
		1104	sub add_item {
		1105	my ($self, $item) = @_;
		1106
		1107	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1108	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1109	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1110
		1111	$item->{render} \|\|= sub { $_[0]{text} };
		1112
		1113	push @{ $self->{item} }, $item;
		1114	}
		1115
		1116	sub add_separator {
		1117	my ($self, $sep) = @_;
		1118
		1119	$sep \|\|= "═";
		1120
		1121	$self->add_item ({
		1122	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1123	text => "",
		1124	render => sub { $sep x $urxvt::TERM->ncol },
		1125	activate => sub { },
		1126	});
		1127	}
		1128
		1129	sub add_title {
		1130	my ($self, $title) = @_;
		1131
		1132	$self->add_item ({
		1133	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1134	text => $title,
		1135	activate => sub { },
		1136	});
		1137	}
		1138
		1139	sub add_button {
		1140	my ($self, $text, $cb) = @_;
		1141
		1142	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1143	}
		1144
		1145	sub add_toggle {
		1146	my ($self, $text, $cb, $value) = @_;
		1147
		1148	my $item; $item = {
		1149	type => "button",
		1150	text => " $text",
		1151	value => $value,
		1152	render => sub { ($item->{value} ? "* " : " ") . $text },
		1153	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1154	};
		1155
		1156	$self->add_item ($item);
		1157	}
		1158
		1159	sub show {
		1160	my ($self) = @_;
		1161
		1162	local $urxvt::popup::self = $self;
		1163
		1164	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1165	"--transient-for" => $self->{term}->parent,
		1166	"-pe" => "urxvt-popup")
		1167	or die "unable to create popup window\n";
		1168	}
		1169
		1170	sub DESTROY {
		1171	my ($self) = @_;
		1172
		1173	$self->{term}->ungrab;
		1174	}
297		1175
298	=head2 The C<urxvt::timer> Class	1176	=head2 The C<urxvt::timer> Class
299		1177
300	This class implements timer watchers/events. Time is represented as a	1178	This class implements timer watchers/events. Time is represented as a
301	fractional number of seconds since the epoch. Example:	1179	fractional number of seconds since the epoch. Example:
302		1180
303	# create a digital clock display in upper right corner	1181	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
304	$term->{timer} = urxvt::timer	1182	$term->{timer} = urxvt::timer
305	->new	1183	->new
306	->start (urxvt::NOW)	1184	->interval (1)
307	->cb (sub {	1185	->cb (sub {
308	my ($timer) = @_;
309	my $time = $timer->at;
310	$timer->start ($time + 1);
311	$self->scr_overlay (-1, 0,	1186	$term->{overlay}->set (0, 0,
312	POSIX::strftime "%H:%M:%S", localtime $time);	1187	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
313	});	1188	});
314		1189
315	=over 4	1190	=over 4
316		1191
317	=item $timer = new urxvt::timer	1192	=item $timer = new urxvt::timer
318		1193
319	Create a new timer object in stopped state.	1194	Create a new timer object in started state. It is scheduled to fire
		1195	immediately.
320		1196
321	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1197	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
322		1198
323	Set the callback to be called when the timer triggers.	1199	Set the callback to be called when the timer triggers.
324		1200
…		…
327	Return the time this watcher will fire next.	1203	Return the time this watcher will fire next.
328		1204
329	=item $timer = $timer->set ($tstamp)	1205	=item $timer = $timer->set ($tstamp)
330		1206
331	Set the time the event is generated to $tstamp.	1207	Set the time the event is generated to $tstamp.
		1208
		1209	=item $timer = $timer->interval ($interval)
		1210
		1211	Normally (and when C<$interval> is C<0>), the timer will automatically
		1212	stop after it has fired once. If C<$interval> is non-zero, then the timer
		1213	is automatically rescheduled at the given intervals.
332		1214
333	=item $timer = $timer->start	1215	=item $timer = $timer->start
334		1216
335	Start the timer.	1217	Start the timer.
336		1218
…		…
390		1272
391	Stop watching for events on the given filehandle.	1273	Stop watching for events on the given filehandle.
392		1274
393	=back	1275	=back
394		1276
		1277	=head1 ENVIRONMENT
		1278
		1279	=head2 URXVT_PERL_VERBOSITY
		1280
		1281	This variable controls the verbosity level of the perl extension. Higher
		1282	numbers indicate more verbose output.
		1283
		1284	=over 4
		1285
		1286	=item =0 - only fatal messages
		1287
		1288	=item =3 - script loading and management
		1289
		1290	=item =10 - all events received
		1291
		1292	=back
		1293
395	=head1 AUTHOR	1294	=head1 AUTHOR
396		1295
397	Marc Lehmann <pcg@goof.com>	1296	Marc Lehmann <pcg@goof.com>
398	http://software.schmorp.de/pkg/rxvt-unicode	1297	http://software.schmorp.de/pkg/rxvt-unicode
399		1298

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.55 by root, Sun Jan 8 05:50:27 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.55 by root, Sun Jan 8 05:50:27 2006 UTC