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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.82 by root, Thu Jan 12 01:30:53 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	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.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click). Right now, it tries to
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	select urls and complete shell-quoted arguments, which is very convenient,
47	if your F<ls> supports C<--quoting-style=shell>.	47	too, if your F<ls> supports C<--quoting-style=shell>.
48		48
49	It also offers the following bindable event:	49	It also offers the following bindable keyboard command:
50		50
51	=over 4	51	=over 4
52		52
53	=item rot13	53	=item rot13
54		54
…		…
56		56
57	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
58		58
59	=back	59	=back
60		60
		61	=item option-popup (enabled by default)
		62
		63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		64	runtime.
		65
		66	=item selection-popup (enabled by default)
		67
		68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		69	text into various other formats/action (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
		71
		72	=item searchable-scrollback<hotkey> (enabled by default)
		73
		74	Adds regex search functionality to the scrollback buffer, triggered
		75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		76	input/output is suspended.
		77
		78	C</> starts an incremental regex search, C<n> searches further, C<p> or
		79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		80	history, C<enter> leaves search mode at the current position and C<escape>
		81	returns to the original position.
		82
61	=item digital-clock	83	=item digital-clock
62		84
63	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
		86
		87	=item mark-urls
		88
		89	Uses per-line display filtering (C<on_line_update>) to underline urls and
		90	make them clickable. When clicked, the program specified in the resource
		91	C<urlLauncher> (default C<x-www-browser>) will be started.
		92
		93	=item block-graphics-to-ascii
		94
		95	A not very useful example of filtering all text output to the terminal,
		96	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		97	similar-looking ascii character.
64		98
65	=item example-refresh-hooks	99	=item example-refresh-hooks
66		100
67	Displays a very simple digital clock in the upper right corner of the	101	Displays a very simple digital clock in the upper right corner of the
68	window. Illustrates overwriting the refresh callbacks to create your own	102	window. Illustrates overwriting the refresh callbacks to create your own
69	overlays or changes.	103	overlays or changes.
70		104
71	=back	105	=back
		106
		107	=head1 API DOCUMENTATION
72		108
73	=head2 General API Considerations	109	=head2 General API Considerations
74		110
75	All objects (such as terminals, time watchers etc.) are typical	111	All objects (such as terminals, time watchers etc.) are typical
76	reference-to-hash objects. The hash can be used to store anything you	112	reference-to-hash objects. The hash can be used to store anything you
…		…
81	When objects are destroyed on the C++ side, the perl object hashes are	117	When objects are destroyed on the C++ side, the perl object hashes are
82	emptied, so its best to store related objects such as time watchers and	118	emptied, so its best to store related objects such as time watchers and
83	the like inside the terminal object so they get destroyed as soon as the	119	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	120	terminal is destroyed.
85		121
		122	Argument names also often indicate the type of a parameter. Here are some
		123	hints on what they mean:
		124
		125	=over 4
		126
		127	=item $text
		128
		129	Rxvt-unicodes special way of encoding text, where one "unicode" character
		130	always represents one screen cell. See L<ROW_t> for a discussion of this format.
		131
		132	=item $string
		133
		134	A perl text string, with an emphasis on I<text>. It can store all unicode
		135	characters and is to be distinguished with text encoded in a specific
		136	encoding (often locale-specific) and binary data.
		137
		138	=item $octets
		139
		140	Either binary data or - more common - a text string encoded in a
		141	locale-specific way.
		142
		143	=back
		144
		145	=head2 Extension Objects
		146
		147	Very perl extension is a perl class. A separate perl object is created
		148	for each terminal and each extension and passed as the first parameter to
		149	hooks. So extensions can use their C<$self> object without having to think
		150	about other extensions, with the exception of methods and members that
		151	begin with an underscore character C<_>: these are reserved for internal
		152	use.
		153
		154	Although it isn't a C<urxvt::term> object, you can call all methods of the
		155	C<urxvt::term> class on this object.
		156
		157	It has the following methods and data members:
		158
		159	=over 4
		160
		161	=item $urxvt_term = $self->{term}
		162
		163	Returns the C<urxvt::term> object associated with this instance of the
		164	extension. This member I<must not> be changed in any way.
		165
		166	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		167
		168	Dynamically enable the given hooks (named without the C<on_> prefix) for
		169	this extension, replacing any previous hook. This is useful when you want
		170	to overwrite time-critical hooks only temporarily.
		171
		172	=item $self->disable ($hook_name[, $hook_name..])
		173
		174	Dynamically disable the given hooks.
		175
		176	=back
		177
86	=head2 Hooks	178	=head2 Hooks
87		179
88	The following subroutines can be declared in loaded scripts, and will be	180	The following subroutines can be declared in extension files, and will be
89	called whenever the relevant event happens.	181	called whenever the relevant event happens.
90		182
91	The first argument passed to them is an object private to each terminal	183	The first argument passed to them is an extension oject as described in
92	and extension package. You can call all C<urxvt::term> methods on it, but	184	the in the C<Extension Objects> section.
93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94	object that is shared between all packages is stored in the C<term>
95	member.
96		185
97	All of them must return a boolean value. If it is true, then the event	186	B<All> of these hooks must return a boolean value. If it is true, then the
98	counts as being I<consumed>, and the invocation of other hooks is skipped,	187	event counts as being I<consumed>, and the invocation of other hooks is
99	and the relevant action might not be carried out by the C++ code.	188	skipped, and the relevant action might not be carried out by the C++ code.
100		189
101	When in doubt, return a false value (preferably C<()>).	190	I<< When in doubt, return a false value (preferably C<()>). >>
102		191
103	=over 4	192	=over 4
104		193
105	=item on_init $term	194	=item on_init $term
106		195
107	Called after a new terminal object has been initialized, but before	196	Called after a new terminal object has been initialized, but before
108	windows are created or the command gets run.	197	windows are created or the command gets run. Most methods are unsafe to
		198	call or deliver senseless data, as terminal size and other characteristics
		199	have not yet been determined. You can safely query and change resources,
		200	though.
109		201
110	=item on_reset $term	202	=item on_reset $term
111		203
112	Called after the screen is "reset" for any reason, such as resizing or	204	Called after the screen is "reset" for any reason, such as resizing or
113	control sequences. Here is where you can react on changes to size-related	205	control sequences. Here is where you can react on changes to size-related
…		…
142	should extend the selection itelf and return true to suppress the built-in	234	should extend the selection itelf and return true to suppress the built-in
143	processing.	235	processing.
144		236
145	See the F<selection> example extension.	237	See the F<selection> example extension.
146		238
147	=item on_focus_in $term
148
149	Called whenever the window gets the keyboard focus, before urxvt does
150	focus in processing.
151
152	=item on_focus_out $term
153
154	Called wheneever the window loses keyboard focus, before urxvt does focus
155	out processing.
156
157	=item on_view_change $term, $offset	239	=item on_view_change $term, $offset
158		240
159	Called whenever the view offset changes, i..e the user or program	241	Called whenever the view offset changes, i..e the user or program
160	scrolls. Offset C<0> means display the normal terminal, positive values	242	scrolls. Offset C<0> means display the normal terminal, positive values
161	show this many lines of scrollback.	243	show this many lines of scrollback.
…		…
167	than the scroll back buffer or the terminal.	249	than the scroll back buffer or the terminal.
168		250
169	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	251	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
170	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	252	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
171	number of lines that will be in the scrollback buffer.	253	number of lines that will be in the scrollback buffer.
172
173	=item on_tty_activity $term NYI
174
175	Called whenever the program(s) running in the urxvt window send output.
176		254
177	=item on_osc_seq $term, $string	255	=item on_osc_seq $term, $string
178		256
179	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	257	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180	operating system command) is processed. Cursor position and other state	258	operating system command) is processed. Cursor position and other state
…		…
185		263
186	Be careful not ever to trust (in a security sense) the data you receive,	264	Be careful not ever to trust (in a security sense) the data you receive,
187	as its source can not easily be controleld (e-mail content, messages from	265	as its source can not easily be controleld (e-mail content, messages from
188	other users on the same system etc.).	266	other users on the same system etc.).
189		267
		268	=item on_add_lines $term, $string
		269
		270	Called whenever text is about to be output, with the text as argument. You
		271	can filter/change and output the text yourself by returning a true value
		272	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		273	might be very slow, however, as your hook is called for B<all> text being
		274	output.
		275
		276	=item on_tt_write $term, $octets
		277
		278	Called whenever some data is written to the tty/pty and can be used to
		279	suppress or filter tty input.
		280
		281	=item on_line_update $term, $row
		282
		283	Called whenever a line was updated or changed. Can be used to filter
		284	screen output (e.g. underline urls or other useless stuff). Only lines
		285	that are being shown will be filtered, and, due to performance reasons,
		286	not always immediately.
		287
		288	The row number is always the topmost row of the line if the line spans
		289	multiple rows.
		290
		291	Please note that, if you change the line, then the hook might get called
		292	later with the already-modified line (e.g. if unrelated parts change), so
		293	you cannot just toggle rendition bits, but only set them.
		294
190	=item on_refresh_begin $term	295	=item on_refresh_begin $term
191		296
192	Called just before the screen gets redrawn. Can be used for overlay	297	Called just before the screen gets redrawn. Can be used for overlay
193	or similar effects by modify terminal contents in refresh_begin, and	298	or similar effects by modify terminal contents in refresh_begin, and
194	restoring them in refresh_end. The built-in overlay and selection display	299	restoring them in refresh_end. The built-in overlay and selection display
…		…
202		307
203	Called whenever the user presses a key combination that has a	308	Called whenever the user presses a key combination that has a
204	C<perl:string> action bound to it (see description of the B<keysym>	309	C<perl:string> action bound to it (see description of the B<keysym>
205	resource in the @@RXVT_NAME@@(1) manpage).	310	resource in the @@RXVT_NAME@@(1) manpage).
206		311
		312	=item on_focus_in $term
		313
		314	Called whenever the window gets the keyboard focus, before rxvt-unicode
		315	does focus in processing.
		316
		317	=item on_focus_out $term
		318
		319	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		320	focus out processing.
		321
		322	=item on_key_press $term, $event, $keysym, $octets
		323
		324	=item on_key_release $term, $event, $keysym
		325
		326	=item on_button_press $term, $event
		327
		328	=item on_button_release $term, $event
		329
		330	=item on_motion_notify $term, $event
		331
		332	=item on_map_notify $term, $event
		333
		334	=item on_unmap_notify $term, $event
		335
		336	Called whenever the corresponding X event is received for the terminal If
		337	the hook returns true, then the even will be ignored by rxvt-unicode.
		338
		339	The event is a hash with most values as named by Xlib (see the XEvent
		340	manpage), with the additional members C<row> and C<col>, which are the row
		341	and column under the mouse cursor.
		342
		343	C<on_key_press> additionally receives the string rxvt-unicode would
		344	output, if any, in locale-specific encoding.
		345
		346	subwindow.
		347
207	=back	348	=back
208		349
		350	=cut
		351
		352	package urxvt;
		353
		354	use utf8;
		355	use strict;
		356	use Carp ();
		357	use Scalar::Util ();
		358	use List::Util ();
		359
		360	our $VERSION = 1;
		361	our $TERM;
		362	our @HOOKNAME;
		363	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		364	our %OPTION;
		365
		366	our $LIBDIR;
		367	our $RESNAME;
		368	our $RESCLASS;
		369	our $RXVTNAME;
		370
209	=head2 Variables in the C<urxvt> Package	371	=head2 Variables in the C<urxvt> Package
210		372
211	=over 4	373	=over 4
212		374
		375	=item $urxvt::LIBDIR
		376
		377	The rxvt-unicode library directory, where, among other things, the perl
		378	modules and scripts are stored.
		379
		380	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		381
		382	The resource class and name rxvt-unicode uses to look up X resources.
		383
		384	=item $urxvt::RXVTNAME
		385
		386	The basename of the installed binaries, usually C<urxvt>.
		387
213	=item $urxvt::TERM	388	=item $urxvt::TERM
214		389
215	The current terminal. Whenever a callback/Hook is bein executed, this	390	The current terminal. This variable stores the current C<urxvt::term>
216	variable stores the current C<urxvt::term> object.	391	object, whenever a callback/hook is executing.
217		392
218	=back	393	=back
219		394
220	=head2 Functions in the C<urxvt> Package	395	=head2 Functions in the C<urxvt> Package
221		396
…		…
234	that calls this function.	409	that calls this function.
235		410
236	Using this function has the advantage that its output ends up in the	411	Using this function has the advantage that its output ends up in the
237	correct place, e.g. on stderr of the connecting urxvtc client.	412	correct place, e.g. on stderr of the connecting urxvtc client.
238		413
		414	Messages have a size limit of 1023 bytes currently.
		415
		416	=item $is_safe = urxvt::safe
		417
		418	Returns true when it is safe to do potentially unsafe things, such as
		419	evaluating perl code specified by the user. This is true when urxvt was
		420	started setuid or setgid.
		421
239	=item $time = urxvt::NOW	422	=item $time = urxvt::NOW
240		423
241	Returns the "current time" (as per the event loop).	424	Returns the "current time" (as per the event loop).
		425
		426	=item urxvt::CurrentTime
		427
		428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		430	Button4Mask, Button5Mask, AnyModifier
		431
		432	Various constants for use in X calls and event processing.
242		433
243	=back	434	=back
244		435
245	=head2 RENDITION	436	=head2 RENDITION
246		437
…		…
273		464
274	=item $background = urxvt::GET_BASEBG $rend	465	=item $background = urxvt::GET_BASEBG $rend
275		466
276	Return the foreground/background colour index, respectively.	467	Return the foreground/background colour index, respectively.
277		468
278	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
279		470
280	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
281		472
282	Replace the foreground/background colour in the rendition mask with the	473	Replace the foreground/background colour in the rendition mask with the
283	specified one.	474	specified one.
284		475
285	=item $value = urxvt::GET_CUSTOM ($rend)	476	=item $value = urxvt::GET_CUSTOM $rend
286		477
287	Return the "custom" value: Every rendition has 5 bits for use by	478	Return the "custom" value: Every rendition has 5 bits for use by
288	extensions. They can be set and changed as you like and are initially	479	extensions. They can be set and changed as you like and are initially
289	zero.	480	zero.
290		481
291	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	482	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
292		483
293	Change the custom value.	484	Change the custom value.
294		485
295	=back	486	=back
296		487
297	=cut	488	=cut
298
299	package urxvt;
300
301	use strict;
302	use Scalar::Util ();
303
304	our $TERM;
305	our @HOOKNAME;
306	our $LIBDIR;
307		489
308	BEGIN {	490	BEGIN {
309	urxvt->bootstrap;	491	urxvt->bootstrap;
310		492
311	# overwrite perl's warn	493	# overwrite perl's warn
…		…
313	my $msg = join "", @_;	495	my $msg = join "", @_;
314	$msg .= "\n"	496	$msg .= "\n"
315	unless $msg =~ /\n$/;	497	unless $msg =~ /\n$/;
316	urxvt::warn ($msg);	498	urxvt::warn ($msg);
317	};	499	};
		500
		501	# %ENV is the original startup environment
		502	delete $ENV{IFS};
		503	delete $ENV{CDPATH};
		504	delete $ENV{BASH_ENV};
		505	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
318	}	506	}
319		507
320	my @hook_count;	508	my @hook_count;
321	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	509	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
322		510
323	sub verbose {	511	sub verbose {
324	my ($level, $msg) = @_;	512	my ($level, $msg) = @_;
325	warn "$msg\n" if $level <= $verbosity;	513	warn "$msg\n" if $level <= $verbosity;
326	}	514	}
327		515
328	# find on_xxx subs in the package and register them	516	my $extension_pkg = "extension0000";
329	# as hooks	517	my %extension_pkg;
330	sub register_package($) {
331	my ($pkg) = @_;
332
333	for my $htype (0.. $#HOOKNAME) {
334	my $name = $HOOKNAME[$htype];
335
336	my $ref = $pkg->can ("on_" . lc $name)
337	or next;
338
339	$TERM->{_hook}[$htype]{$pkg} = $ref;
340	$hook_count[$htype]++
341	or set_should_invoke $htype, 1;
342	}
343	}
344
345	my $script_pkg = "script0000";
346	my %script_pkg;
347		518
348	# load a single script into its own package, once only	519	# load a single script into its own package, once only
349	sub script_package($) {	520	sub extension_package($) {
350	my ($path) = @_;	521	my ($path) = @_;
351		522
352	$script_pkg{$path} \|\|= do {	523	$extension_pkg{$path} \|\|= do {
353	my $pkg = "urxvt::" . ($script_pkg++);	524	my $pkg = "urxvt::" . ($extension_pkg++);
354		525
355	verbose 3, "loading script '$path' into package '$pkg'";	526	verbose 3, "loading extension '$path' into package '$pkg'";
356		527
357	open my $fh, "<:raw", $path	528	open my $fh, "<:raw", $path
358	or die "$path: $!";	529	or die "$path: $!";
359		530
		531	my $source = untaint
360	my $source = "package $pkg; use strict; use utf8;\n"	532	"package $pkg; use strict; use utf8;\n"
		533	. "use base urxvt::term::extension::;\n"
361	. "#line 1 \"$path\"\n{\n"	534	. "#line 1 \"$path\"\n{\n"
362	. (do { local $/; <$fh> })	535	. (do { local $/; <$fh> })
363	. "\n};\n1";	536	. "\n};\n1";
364		537
		538	eval $source
365	eval $source or die "$path: $@";	539	or die "$path: $@";
366		540
367	$pkg	541	$pkg
368	}	542	}
369	}	543	}
370		544
…		…
375	local $TERM = shift;	549	local $TERM = shift;
376	my $htype = shift;	550	my $htype = shift;
377		551
378	if ($htype == 0) { # INIT	552	if ($htype == 0) { # INIT
379	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	553	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		554
		555	my %ext_arg;
380		556
381	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	557	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		558	if ($_ eq "default") {
		559	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		560	} elsif (/^-(.*)$/) {
		561	delete $ext_arg{$1};
		562	} elsif (/^([^<]+)<(.*)>$/) {
		563	push @{ $ext_arg{$1} }, $2;
		564	} else {
		565	$ext_arg{$_} \|\|= [];
		566	}
		567	}
		568
		569	while (my ($ext, $argv) = each %ext_arg) {
382	my @files = grep -f $_, map "$_/$ext", @dirs;	570	my @files = grep -f $_, map "$_/$ext", @dirs;
383		571
384	if (@files) {	572	if (@files) {
385	register_package script_package $files[0];	573	$TERM->register_package (extension_package $files[0], $argv);
386	} else {	574	} else {
387	warn "perl extension '$ext' not found in perl library search path\n";	575	warn "perl extension '$ext' not found in perl library search path\n";
388	}	576	}
389	}	577	}
		578
		579	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		580	warn $@ if $@;
390	}	581	}
391		582
392	$retval = undef;	583	$retval = undef;
393		584
394	if (my $cb = $TERM->{_hook}[$htype]) {	585	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
396	if $verbosity >= 10;	587	if $verbosity >= 10;
397		588
398	keys %$cb;	589	keys %$cb;
399		590
400	while (my ($pkg, $cb) = each %$cb) {	591	while (my ($pkg, $cb) = each %$cb) {
401	$retval = $cb->(	592	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
402	$TERM->{_pkg}{$pkg} \|\|= do {
403	my $proxy = bless { }, urxvt::term::proxy::;
404	Scalar::Util::weaken ($proxy->{term} = $TERM);
405	$proxy
406	},
407	@_,
408	) and last;	593	and last;
		594
		595	if ($@) {
		596	$TERM->ungrab; # better to lose the grab than the session
		597	warn $@;
		598	}
409	}	599	}
410	}	600	}
411		601
412	if ($htype == 1) { # DESTROY	602	if ($htype == 1) { # DESTROY
413	# remove hooks if unused
414	if (my $hook = $TERM->{_hook}) {	603	if (my $hook = delete $TERM->{_hook}) {
415	for my $htype (0..$#$hook) {	604	for my $htype (0..$#$hook) {
416	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	605	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
417	or set_should_invoke $htype, 0;	606	or set_should_invoke $htype, 0;
418	}	607	}
419	}	608	}
…		…
426	}	615	}
427		616
428	$retval	617	$retval
429	}	618	}
430		619
431	sub urxvt::term::proxy::AUTOLOAD {	620	# urxvt::term::extension
432	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	621
		622	package urxvt::term::extension;
		623
		624	sub enable {
		625	my ($self, %hook) = @_;
		626	my $pkg = $self->{_pkg};
		627
		628	while (my ($name, $cb) = each %hook) {
		629	my $htype = $HOOKTYPE{uc $name};
		630	defined $htype
		631	or Carp::croak "unsupported hook type '$name'";
		632
		633	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		634	$hook_count[$htype]++
		635	or urxvt::set_should_invoke $htype, 1;
		636	}
		637
		638	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		639	}
		640	}
		641
		642	sub disable {
		643	my ($self, @hook) = @_;
		644	my $pkg = $self->{_pkg};
		645
		646	for my $name (@hook) {
		647	my $htype = $HOOKTYPE{uc $name};
		648	defined $htype
		649	or Carp::croak "unsupported hook type '$name'";
		650
		651	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		652	--$hook_count[$htype]
		653	or urxvt::set_should_invoke $htype, 0;
		654	}
		655	}
		656	}
		657
		658	our $AUTOLOAD;
		659
		660	sub AUTOLOAD {
		661	$AUTOLOAD =~ /:([^:]+)$/
433	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	662	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
434		663
435	eval qq{	664	eval qq{
436	sub $urxvt::term::proxy::AUTOLOAD {	665	sub $AUTOLOAD {
437	my \$proxy = shift;	666	my \$proxy = shift;
438	\$proxy->{term}->$1 (\@_)	667	\$proxy->{term}->$1 (\@_)
439	}	668	}
440	1	669	1
441	} or die "FATAL: unable to compile method forwarder: $@";	670	} or die "FATAL: unable to compile method forwarder: $@";
442		671
443	goto &$urxvt::term::proxy::AUTOLOAD;	672	goto &$AUTOLOAD;
444	}	673	}
		674
		675	sub DESTROY {
		676	# nop
		677	}
		678
		679	# urxvt::destroy_hook
		680
		681	sub urxvt::destroy_hook::DESTROY {
		682	${$_[0]}->();
		683	}
		684
		685	sub urxvt::destroy_hook(&) {
		686	bless \shift, urxvt::destroy_hook::
		687	}
		688
		689	package urxvt::anyevent;
		690
		691	=head2 The C<urxvt::anyevent> Class
		692
		693	The sole purpose of this class is to deliver an interface to the
		694	C<AnyEvent> module - any module using it will work inside urxvt without
		695	further programming. The only exception is that you cannot wait on
		696	condition variables, but non-blocking condvar use is ok. What this means
		697	is that you cannot use blocking APIs, but the non-blocking variant should
		698	work.
		699
		700	=cut
		701
		702	our $VERSION = 1;
		703
		704	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		705	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		706
		707	sub timer {
		708	my ($class, %arg) = @_;
		709
		710	my $cb = $arg{cb};
		711
		712	urxvt::timer
		713	->new
		714	->start (urxvt::NOW + $arg{after})
		715	->cb (sub {
		716	$_[0]->stop; # need to cancel manually
		717	$cb->();
		718	})
		719	}
		720
		721	sub io {
		722	my ($class, %arg) = @_;
		723
		724	my $cb = $arg{cb};
		725
		726	bless [$arg{fh}, urxvt::iow
		727	->new
		728	->fd (fileno $arg{fh})
		729	->events (($arg{poll} =~ /r/ ? 1 : 0)
		730	\| ($arg{poll} =~ /w/ ? 2 : 0))
		731	->start
		732	->cb (sub {
		733	$cb->(($_[1] & 1 ? 'r' : '')
		734	. ($_[1] & 2 ? 'w' : ''));
		735	})],
		736	urxvt::anyevent::
		737	}
		738
		739	sub DESTROY {
		740	$_[0][1]->stop;
		741	}
		742
		743	sub condvar {
		744	bless \my $flag, urxvt::anyevent::condvar::
		745	}
		746
		747	sub urxvt::anyevent::condvar::broadcast {
		748	${$_[0]}++;
		749	}
		750
		751	sub urxvt::anyevent::condvar::wait {
		752	unless (${$_[0]}) {
		753	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		754	}
		755	}
		756
		757	package urxvt::term;
445		758
446	=head2 The C<urxvt::term> Class	759	=head2 The C<urxvt::term> Class
447		760
448	=over 4	761	=over 4
		762
		763	=cut
		764
		765	# find on_xxx subs in the package and register them
		766	# as hooks
		767	sub register_package {
		768	my ($self, $pkg, $argv) = @_;
		769
		770	my $proxy = bless {
		771	_pkg => $pkg,
		772	argv => $argv,
		773	}, $pkg;
		774	Scalar::Util::weaken ($proxy->{term} = $self);
		775
		776	$self->{_pkg}{$pkg} = $proxy;
		777
		778	for my $name (@HOOKNAME) {
		779	if (my $ref = $pkg->can ("on_" . lc $name)) {
		780	$proxy->enable ($name => $ref);
		781	}
		782	}
		783	}
		784
		785	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		786
		787	Creates a new terminal, very similar as if you had started it with system
		788	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		789	hash which defines the environment of the new terminal.
		790
		791	Croaks (and probably outputs an error message) if the new instance
		792	couldn't be created. Returns C<undef> if the new instance didn't
		793	initialise perl, and the terminal object otherwise. The C<init> and
		794	C<start> hooks will be called during this call.
		795
		796	=cut
		797
		798	sub new {
		799	my ($class, $env, @args) = @_;
		800
		801	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		802	}
		803
		804	=item $term->destroy
		805
		806	Destroy the terminal object (close the window, free resources
		807	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		808	watchers (timers, io watchers) are still active.
		809
		810	=item $isset = $term->option ($optval[, $set])
		811
		812	Returns true if the option specified by C<$optval> is enabled, and
		813	optionally change it. All option values are stored by name in the hash
		814	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		815
		816	Here is a a likely non-exhaustive list of option names, please see the
		817	source file F</src/optinc.h> to see the actual list:
		818
		819	borderLess console cursorBlink cursorUnderline hold iconic insecure
		820	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		821	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		822	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		823	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		824	tripleclickwords utmpInhibit visualBell
449		825
450	=item $value = $term->resource ($name[, $newval])	826	=item $value = $term->resource ($name[, $newval])
451		827
452	Returns the current resource value associated with a given name and	828	Returns the current resource value associated with a given name and
453	optionally sets a new value. Setting values is most useful in the C<init>	829	optionally sets a new value. Setting values is most useful in the C<init>
…		…
463		839
464	Please note that resource strings will currently only be freed when the	840	Please note that resource strings will currently only be freed when the
465	terminal is destroyed, so changing options frequently will eat memory.	841	terminal is destroyed, so changing options frequently will eat memory.
466		842
467	Here is a a likely non-exhaustive list of resource names, not all of which	843	Here is a a likely non-exhaustive list of resource names, not all of which
468	are supported in every build, please see the source to see the actual	844	are supported in every build, please see the source file F</src/rsinc.h>
469	list:	845	to see the actual list:
470		846
471	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	847	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
472	borderLess color cursorBlink cursorUnderline cutchars delete_key	848	borderLess color cursorBlink cursorUnderline cutchars delete_key
473	display_name embed ext_bwidth fade font geometry hold iconName	849	display_name embed ext_bwidth fade font geometry hold iconName
474	imFont imLocale inputMethod insecure int_bwidth intensityStyles	850	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
481	shade term_name title transparent transparent_all tripleclickwords	857	shade term_name title transparent transparent_all tripleclickwords
482	utmpInhibit visualBell	858	utmpInhibit visualBell
483		859
484	=cut	860	=cut
485		861
486	sub urxvt::term::resource($$;$) {	862	sub resource($$;$) {
487	my ($self, $name) = (shift, shift);	863	my ($self, $name) = (shift, shift);
488	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	864	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
489	goto &urxvt::term::_resource;	865	&urxvt::term::_resource
490	}	866	}
491		867
		868	=item $value = $term->x_resource ($pattern)
		869
		870	Returns the X-Resource for the given pattern, excluding the program or
		871	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		872	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		873	resource with that pattern exists.
		874
		875	This method should only be called during the C<on_start> hook, as there is
		876	only one resource database per display, and later invocations might return
		877	the wrong resources.
		878
		879	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		880
		881	Adds a keymap translation exactly as specified via a resource. See the
		882	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		883
492	=item $rend = $term->screen_rstyle ([$new_rstyle])	884	=item $rend = $term->rstyle ([$new_rstyle])
493		885
494	Return and optionally change the current rendition. Text thta is output by	886	Return and optionally change the current rendition. Text that is output by
495	the temrianl application will use this style.	887	the terminal application will use this style.
496		888
497	=item ($row, $col) = $term->screen_cur ([$row, $col])	889	=item ($row, $col) = $term->screen_cur ([$row, $col])
498		890
499	Return the current coordinates of the text cursor position and optionally	891	Return the current coordinates of the text cursor position and optionally
500	set it (which is usually bad as applications don't expect that).	892	set it (which is usually bad as applications don't expect that).
…		…
515		907
516	=item $oldtext = $term->selection ([$newtext])	908	=item $oldtext = $term->selection ([$newtext])
517		909
518	Return the current selection text and optionally replace it by C<$newtext>.	910	Return the current selection text and optionally replace it by C<$newtext>.
519		911
520	#=item $term->overlay ($x, $y, $text)	912	=item $term->overlay_simple ($x, $y, $text)
521	#	913
522	#Create a simple multi-line overlay box. See the next method for details.	914	Create a simple multi-line overlay box. See the next method for details.
523	#	915
524	#=cut	916	=cut
525		917
526	sub urxvt::term::scr_overlay {	918	sub overlay_simple {
527	die;
528	my ($self, $x, $y, $text) = @_;	919	my ($self, $x, $y, $text) = @_;
529		920
530	my @lines = split /\n/, $text;	921	my @lines = split /\n/, $text;
531		922
532	my $w = 0;	923	my $w = List::Util::max map $self->strwidth ($_), @lines;
533	for (map $self->strwidth ($_), @lines) {
534	$w = $_ if $w < $_;
535	}
536		924
537	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	925	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
538	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	926	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		927
		928	$overlay
539	}	929	}
540		930
541	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	931	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
542		932
543	Create a new (empty) overlay at the given position with the given	933	Create a new (empty) overlay at the given position with the given
…		…
571		961
572	If hidden, display the overlay again.	962	If hidden, display the overlay again.
573		963
574	=back	964	=back
575		965
		966	=item $popup = $term->popup ($event)
		967
		968	Creates a new C<urxvt::popup> object that implements a popup menu. The
		969	C<$event> I<must> be the event causing the menu to pop up (a button event,
		970	currently).
		971
		972	=cut
		973
		974	sub popup {
		975	my ($self, $event) = @_;
		976
		977	$self->grab ($event->{time}, 1)
		978	or return;
		979
		980	my $popup = bless {
		981	term => $self,
		982	event => $event,
		983	}, urxvt::popup::;
		984
		985	Scalar::Util::weaken $popup->{term};
		986
		987	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		988	Scalar::Util::weaken $self->{_destroy}{$popup};
		989
		990	$popup
		991	}
		992
576	=item $cellwidth = $term->strwidth $string	993	=item $cellwidth = $term->strwidth ($string)
577		994
578	Returns the number of screen-cells this string would need. Correctly	995	Returns the number of screen-cells this string would need. Correctly
579	accounts for wide and combining characters.	996	accounts for wide and combining characters.
580		997
581	=item $octets = $term->locale_encode $string	998	=item $octets = $term->locale_encode ($string)
582		999
583	Convert the given text string into the corresponding locale encoding.	1000	Convert the given text string into the corresponding locale encoding.
584		1001
585	=item $string = $term->locale_decode $octets	1002	=item $string = $term->locale_decode ($octets)
586		1003
587	Convert the given locale-encoded octets into a perl string.	1004	Convert the given locale-encoded octets into a perl string.
		1005
		1006	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1007
		1008	XORs the rendition values in the given span with the provided value
		1009	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		1010	to the selection.
		1011
		1012	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1013
		1014	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1015	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1016	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1017	it instead.
		1018
		1019	=item $term->scr_bell
		1020
		1021	Ring the bell!
		1022
		1023	=item $term->scr_add_lines ($string)
		1024
		1025	Write the given text string to the screen, as if output by the application
		1026	running inside the terminal. It may not contain command sequences (escape
		1027	codes), but is free to use line feeds, carriage returns and tabs. The
		1028	string is a normal text string, not in locale-dependent encoding.
		1029
		1030	Normally its not a good idea to use this function, as programs might be
		1031	confused by changes in cursor position or scrolling. Its useful inside a
		1032	C<on_add_lines> hook, though.
		1033
		1034	=item $term->cmd_parse ($octets)
		1035
		1036	Similar to C<scr_add_lines>, but the argument must be in the
		1037	locale-specific encoding of the terminal and can contain command sequences
		1038	(escape codes) that will be interpreted.
588		1039
589	=item $term->tt_write ($octets)	1040	=item $term->tt_write ($octets)
590		1041
591	Write the octets given in C<$data> to the tty (i.e. as program input). To	1042	Write the octets given in C<$data> to the tty (i.e. as program input). To
592	pass characters instead of octets, you should convert your strings first	1043	pass characters instead of octets, you should convert your strings first
593	to the locale-specific encoding using C<< $term->locale_encode >>.	1044	to the locale-specific encoding using C<< $term->locale_encode >>.
594		1045
		1046	=item $old_events = $term->pty_ev_events ([$new_events])
		1047
		1048	Replaces the event mask of the pty watcher by the given event mask. Can
		1049	be used to suppress input and output handling to the pty/tty. See the
		1050	description of C<< urxvt::timer->events >>. Make sure to always restore
		1051	the previous value.
		1052
		1053	=item $windowid = $term->parent
		1054
		1055	Return the window id of the toplevel window.
		1056
		1057	=item $windowid = $term->vt
		1058
		1059	Return the window id of the terminal window.
		1060
595	=item $window_width = $term->width	1061	=item $window_width = $term->width
596		1062
597	=item $window_height = $term->height	1063	=item $window_height = $term->height
598		1064
599	=item $font_width = $term->fwidth	1065	=item $font_width = $term->fwidth
…		…
615	=item $nrow_plus_saveLines = $term->total_rows	1081	=item $nrow_plus_saveLines = $term->total_rows
616		1082
617	=item $lines_in_scrollback = $term->nsaved	1083	=item $lines_in_scrollback = $term->nsaved
618		1084
619	Return various integers describing terminal characteristics.	1085	Return various integers describing terminal characteristics.
		1086
		1087	=item $x_display = $term->display_id
		1088
		1089	Return the DISPLAY used by rxvt-unicode.
		1090
		1091	=item $lc_ctype = $term->locale
		1092
		1093	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1094
		1095	=item $env = $term->env
		1096
		1097	Returns a copy of the environment in effect for the terminal as a hashref
		1098	similar to C<\%ENV>.
		1099
		1100	=cut
		1101
		1102	sub env {
		1103	if (my $env = $_[0]->_env) {
		1104	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1105	} else {
		1106	+{ %ENV }
		1107	}
		1108	}
		1109
		1110	=item $modifiermask = $term->ModLevel3Mask
		1111
		1112	=item $modifiermask = $term->ModMetaMask
		1113
		1114	=item $modifiermask = $term->ModNumLockMask
		1115
		1116	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1117	AltGr), the meta key (often Alt) and the num lock key, if applicable.
620		1118
621	=item $view_start = $term->view_start ([$newvalue])	1119	=item $view_start = $term->view_start ([$newvalue])
622		1120
623	Returns the negative row number of the topmost line. Minimum value is	1121	Returns the negative row number of the topmost line. Minimum value is
624	C<0>, which displays the normal terminal contents. Larger values scroll	1122	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
687	about the logical line that row C<$row_number> is part of. It supports the	1185	about the logical line that row C<$row_number> is part of. It supports the
688	following methods:	1186	following methods:
689		1187
690	=over 4	1188	=over 4
691		1189
692	=item $text = $line->t	1190	=item $text = $line->t ([$new_text])
693		1191
694	Returns the full text of the line, similar to C<ROW_t>	1192	Returns or replaces the full text of the line, similar to C<ROW_t>
695		1193
696	=item $rend = $line->r	1194	=item $rend = $line->r ([$new_rend])
697		1195
698	Returns the full rendition array of the line, similar to C<ROW_r>	1196	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
699		1197
700	=item $length = $line->l	1198	=item $length = $line->l
701		1199
702	Returns the length of the line in cells, similar to C<ROW_l>.	1200	Returns the length of the line in cells, similar to C<ROW_l>.
703		1201
…		…
718		1216
719	=back	1217	=back
720		1218
721	=cut	1219	=cut
722		1220
723	sub urxvt::term::line {	1221	sub line {
724	my ($self, $row) = @_;	1222	my ($self, $row) = @_;
725		1223
726	my $maxrow = $self->nrow - 1;	1224	my $maxrow = $self->nrow - 1;
727		1225
728	my ($beg, $end) = ($row, $row);	1226	my ($beg, $end) = ($row, $row);
…		…
732		1230
733	bless {	1231	bless {
734	term => $self,	1232	term => $self,
735	beg => $beg,	1233	beg => $beg,
736	end => $end,	1234	end => $end,
		1235	ncol => $self->ncol,
737	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1236	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
738	}, urxvt::line::	1237	}, urxvt::line::
739	}	1238	}
740		1239
741	sub urxvt::line::t {	1240	sub urxvt::line::t {
742	my ($self) = @_;	1241	my ($self) = @_;
743		1242
		1243	if (@_ > 1)
		1244	{
		1245	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1246	for $self->{beg} .. $self->{end};
		1247	}
		1248
		1249	defined wantarray &&
744	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1250	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
745	0, $self->{len}	1251	0, $self->{len}
746	}	1252	}
747		1253
748	sub urxvt::line::r {	1254	sub urxvt::line::r {
749	my ($self) = @_;	1255	my ($self) = @_;
750		1256
		1257	if (@_ > 1)
		1258	{
		1259	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1260	for $self->{beg} .. $self->{end};
		1261	}
		1262
		1263	if (defined wantarray) {
751	my $rend = [	1264	my $rend = [
752	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1265	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
753	];	1266	];
754	$#$rend = $self->{len} - 1;	1267	$#$rend = $self->{len} - 1;
755	$rend	1268	return $rend;
		1269	}
		1270
		1271	()
756	}	1272	}
757		1273
758	sub urxvt::line::beg { $_[0]{beg} }	1274	sub urxvt::line::beg { $_[0]{beg} }
759	sub urxvt::line::end { $_[0]{end} }	1275	sub urxvt::line::end { $_[0]{end} }
760	sub urxvt::line::l { $_[0]{len} }	1276	sub urxvt::line::l { $_[0]{len} }
761		1277
762	sub urxvt::line::offset_of {	1278	sub urxvt::line::offset_of {
763	my ($self, $row, $col) = @_;	1279	my ($self, $row, $col) = @_;
764		1280
765	($row - $self->{beg}) * $self->{term}->ncol + $col	1281	($row - $self->{beg}) * $self->{ncol} + $col
766	}	1282	}
767		1283
768	sub urxvt::line::coord_of {	1284	sub urxvt::line::coord_of {
769	my ($self, $offset) = @_;	1285	my ($self, $offset) = @_;
770		1286
771	use integer;	1287	use integer;
772		1288
773	(	1289	(
774	$offset / $self->{term}->ncol + $self->{beg},	1290	$offset / $self->{ncol} + $self->{beg},
775	$offset % $self->{term}->ncol	1291	$offset % $self->{ncol}
776	)	1292	)
777	}	1293	}
778		1294
779	=item ($row, $col) = $line->coord_of ($offset)
780	=item $text = $term->special_encode $string	1295	=item $text = $term->special_encode $string
781		1296
782	Converts a perl string into the special encoding used by rxvt-unicode,	1297	Converts a perl string into the special encoding used by rxvt-unicode,
783	where one character corresponds to one screen cell. See	1298	where one character corresponds to one screen cell. See
784	C<< $term->ROW_t >> for details.	1299	C<< $term->ROW_t >> for details.
785		1300
786	=item $string = $term->special_decode $text	1301	=item $string = $term->special_decode $text
787		1302
788	Converts rxvt-unicodes text reprsentation into a perl string. See	1303	Converts rxvt-unicodes text reprsentation into a perl string. See
789	C<< $term->ROW_t >> for details.	1304	C<< $term->ROW_t >> for details.
		1305
		1306	=item $success = $term->grab_button ($button, $modifiermask)
		1307
		1308	Registers a synchronous button grab. See the XGrabButton manpage.
		1309
		1310	=item $success = $term->grab ($eventtime[, $sync])
		1311
		1312	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1313	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1314
		1315	=item $term->allow_events_async
		1316
		1317	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1318
		1319	=item $term->allow_events_sync
		1320
		1321	Calls XAllowEvents with SyncBoth for the most recent grab.
		1322
		1323	=item $term->allow_events_replay
		1324
		1325	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1326	recent grab.
		1327
		1328	=item $term->ungrab
		1329
		1330	Calls XUngrab for the most recent grab. Is called automatically on
		1331	evaluation errors, as it is better to lose the grab in the error case as
		1332	the session.
		1333
		1334	=back
		1335
		1336	=cut
		1337
		1338	package urxvt::popup;
		1339
		1340	=head2 The C<urxvt::popup> Class
		1341
		1342	=over 4
		1343
		1344	=cut
		1345
		1346	sub add_item {
		1347	my ($self, $item) = @_;
		1348
		1349	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1350	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1351	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1352
		1353	$item->{render} \|\|= sub { $_[0]{text} };
		1354
		1355	push @{ $self->{item} }, $item;
		1356	}
		1357
		1358	=item $popup->add_title ($title)
		1359
		1360	Adds a non-clickable title to the popup.
		1361
		1362	=cut
		1363
		1364	sub add_title {
		1365	my ($self, $title) = @_;
		1366
		1367	$self->add_item ({
		1368	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1369	text => $title,
		1370	activate => sub { },
		1371	});
		1372	}
		1373
		1374	=item $popup->add_separator ([$sepchr])
		1375
		1376	Creates a separator, optionally using the character given as C<$sepchr>.
		1377
		1378	=cut
		1379
		1380	sub add_separator {
		1381	my ($self, $sep) = @_;
		1382
		1383	$sep \|\|= "=";
		1384
		1385	$self->add_item ({
		1386	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1387	text => "",
		1388	render => sub { $sep x $self->{term}->ncol },
		1389	activate => sub { },
		1390	});
		1391	}
		1392
		1393	=item $popup->add_button ($text, $cb)
		1394
		1395	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1396	selected.
		1397
		1398	=cut
		1399
		1400	sub add_button {
		1401	my ($self, $text, $cb) = @_;
		1402
		1403	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1404	}
		1405
		1406	=item $popup->add_toggle ($text, $cb, $initial_value)
		1407
		1408	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1409	whenever it gets toggled, with a boolean indicating its value as its first
		1410	argument.
		1411
		1412	=cut
		1413
		1414	sub add_toggle {
		1415	my ($self, $text, $cb, $value) = @_;
		1416
		1417	my $item; $item = {
		1418	type => "button",
		1419	text => " $text",
		1420	value => $value,
		1421	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1422	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1423	};
		1424
		1425	$self->add_item ($item);
		1426	}
		1427
		1428	=item $popup->show
		1429
		1430	Displays the popup (which is initially hidden).
		1431
		1432	=cut
		1433
		1434	sub show {
		1435	my ($self) = @_;
		1436
		1437	local $urxvt::popup::self = $self;
		1438
		1439	my $env = $self->{term}->env;
		1440	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1441	delete $env->{LC_ALL};
		1442	$env->{LC_CTYPE} = $self->{term}->locale;
		1443
		1444	urxvt::term->new ($env, $self->{term}->resource ("name"),
		1445	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1446	"--transient-for" => $self->{term}->parent,
		1447	"-display" => $self->{term}->display_id,
		1448	"-pe" => "urxvt-popup")
		1449	or die "unable to create popup window\n";
		1450	}
		1451
		1452	sub DESTROY {
		1453	my ($self) = @_;
		1454
		1455	delete $self->{term}{_destroy}{$self};
		1456	$self->{term}->ungrab;
		1457	}
790		1458
791	=back	1459	=back
792		1460
793	=head2 The C<urxvt::timer> Class	1461	=head2 The C<urxvt::timer> Class
794		1462
…		…
849		1517
850	$term->{socket} = ...	1518	$term->{socket} = ...
851	$term->{iow} = urxvt::iow	1519	$term->{iow} = urxvt::iow
852	->new	1520	->new
853	->fd (fileno $term->{socket})	1521	->fd (fileno $term->{socket})
854	->events (1) # wait for read data	1522	->events (urxvt::EVENT_READ)
855	->start	1523	->start
856	->cb (sub {	1524	->cb (sub {
857	my ($iow, $revents) = @_;	1525	my ($iow, $revents) = @_;
858	# $revents must be 1 here, no need to check	1526	# $revents must be 1 here, no need to check
859	sysread $term->{socket}, my $buf, 8192	1527	sysread $term->{socket}, my $buf, 8192
…		…
876		1544
877	Set the filedescriptor (not handle) to watch.	1545	Set the filedescriptor (not handle) to watch.
878		1546
879	=item $iow = $iow->events ($eventmask)	1547	=item $iow = $iow->events ($eventmask)
880		1548
881	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1549	Set the event mask to watch. The only allowed values are
882	data, Bit #1 (value C<2>) enables watching for write data.	1550	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1551	together, or C<urxvt::EVENT_NONE>.
883		1552
884	=item $iow = $iow->start	1553	=item $iow = $iow->start
885		1554
886	Start watching for requested events on the given handle.	1555	Start watching for requested events on the given handle.
887		1556
…		…
898	This variable controls the verbosity level of the perl extension. Higher	1567	This variable controls the verbosity level of the perl extension. Higher
899	numbers indicate more verbose output.	1568	numbers indicate more verbose output.
900		1569
901	=over 4	1570	=over 4
902		1571
903	=item =0 - only fatal messages	1572	=item == 0 - fatal messages
904		1573
905	=item =3 - script loading and management	1574	=item >= 3 - script loading and management
906		1575
907	=item =10 - all events received	1576	=item >=10 - all events received
908		1577
909	=back	1578	=back
910		1579
911	=head1 AUTHOR	1580	=head1 AUTHOR
912		1581

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC vs. Revision 1.82 by root, Thu Jan 12 01:30:53 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.82 by root, Thu Jan 12 01:30:53 2006 UTC