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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC vs.
Revision 1.84 by root, Thu Jan 12 02:20:56 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 middle-clicked, the program specified in the
		91	resource 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	=item mark-urls
72
73	A not very useful example of filtering all text output to the terminal, by
74	underlining all urls that matches a certain regex (i.e. some urls :). It
75	is not very useful because urls that are output in multiple steps (e.g.
76	when typing them) do not get marked.
77
78	=back	105	=back
		106
		107	=head1 API DOCUMENTATION
79		108
80	=head2 General API Considerations	109	=head2 General API Considerations
81		110
82	All objects (such as terminals, time watchers etc.) are typical	111	All objects (such as terminals, time watchers etc.) are typical
83	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
…		…
96	=over 4	125	=over 4
97		126
98	=item $text	127	=item $text
99		128
100	Rxvt-unicodes special way of encoding text, where one "unicode" character	129	Rxvt-unicodes special way of encoding text, where one "unicode" character
101	always represents one screen cell. See L<row_t> for a discussion of this format.	130	always represents one screen cell. See L<ROW_t> for a discussion of this format.
102		131
103	=item $string	132	=item $string
104		133
105	A perl text string, with an emphasis on I<text>. It can store all unicode	134	A perl text string, with an emphasis on I<text>. It can store all unicode
106	characters and is to be distinguished with text encoded in a specific	135	characters and is to be distinguished with text encoded in a specific
…		…
111	Either binary data or - more common - a text string encoded in a	140	Either binary data or - more common - a text string encoded in a
112	locale-specific way.	141	locale-specific way.
113		142
114	=back	143	=back
115		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
116	=head2 Hooks	178	=head2 Hooks
117		179
118	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
119	called whenever the relevant event happens.	181	called whenever the relevant event happens.
120		182
121	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
122	and extension package. You can call all C<urxvt::term> methods on it, but	184	the in the C<Extension Objects> section.
123	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
124	object that is shared between all packages is stored in the C<term>
125	member.
126		185
127	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
128	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
129	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.
130		189
131	When in doubt, return a false value (preferably C<()>).	190	I<< When in doubt, return a false value (preferably C<()>). >>
132		191
133	=over 4	192	=over 4
134		193
135	=item on_init $term	194	=item on_init $term
136		195
137	Called after a new terminal object has been initialized, but before	196	Called after a new terminal object has been initialized, but before
138	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.
139		201
140	=item on_reset $term	202	=item on_reset $term
141		203
142	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
143	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
…		…
172	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
173	processing.	235	processing.
174		236
175	See the F<selection> example extension.	237	See the F<selection> example extension.
176		238
177	=item on_focus_in $term
178
179	Called whenever the window gets the keyboard focus, before urxvt does
180	focus in processing.
181
182	=item on_focus_out $term
183
184	Called wheneever the window loses keyboard focus, before urxvt does focus
185	out processing.
186
187	=item on_view_change $term, $offset	239	=item on_view_change $term, $offset
188		240
189	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
190	scrolls. Offset C<0> means display the normal terminal, positive values	242	scrolls. Offset C<0> means display the normal terminal, positive values
191	show this many lines of scrollback.	243	show this many lines of scrollback.
…		…
197	than the scroll back buffer or the terminal.	249	than the scroll back buffer or the terminal.
198		250
199	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,
200	$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
201	number of lines that will be in the scrollback buffer.	253	number of lines that will be in the scrollback buffer.
202
203	=item on_tty_activity $term NYI
204
205	Called whenever the program(s) running in the urxvt window send output.
206		254
207	=item on_osc_seq $term, $string	255	=item on_osc_seq $term, $string
208		256
209	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	257	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
210	operating system command) is processed. Cursor position and other state	258	operating system command) is processed. Cursor position and other state
…		…
223	can filter/change and output the text yourself by returning a true value	271	can filter/change and output the text yourself by returning a true value
224	and calling C<< $term->scr_add_lines >> yourself. Please note that this	272	and calling C<< $term->scr_add_lines >> yourself. Please note that this
225	might be very slow, however, as your hook is called for B<all> text being	273	might be very slow, however, as your hook is called for B<all> text being
226	output.	274	output.
227		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
228	=item on_refresh_begin $term	295	=item on_refresh_begin $term
229		296
230	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
231	or similar effects by modify terminal contents in refresh_begin, and	298	or similar effects by modify terminal contents in refresh_begin, and
232	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
…		…
240		307
241	Called whenever the user presses a key combination that has a	308	Called whenever the user presses a key combination that has a
242	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>
243	resource in the @@RXVT_NAME@@(1) manpage).	310	resource in the @@RXVT_NAME@@(1) manpage).
244		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
245	=back	348	=back
246		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
247	=head2 Variables in the C<urxvt> Package	371	=head2 Variables in the C<urxvt> Package
248		372
249	=over 4	373	=over 4
250		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
251	=item $urxvt::TERM	388	=item $urxvt::TERM
252		389
253	The current terminal. Whenever a callback/Hook is bein executed, this	390	The current terminal. This variable stores the current C<urxvt::term>
254	variable stores the current C<urxvt::term> object.	391	object, whenever a callback/hook is executing.
255		392
256	=back	393	=back
257		394
258	=head2 Functions in the C<urxvt> Package	395	=head2 Functions in the C<urxvt> Package
259		396
…		…
272	that calls this function.	409	that calls this function.
273		410
274	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
275	correct place, e.g. on stderr of the connecting urxvtc client.	412	correct place, e.g. on stderr of the connecting urxvtc client.
276		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
277	=item $time = urxvt::NOW	422	=item $time = urxvt::NOW
278		423
279	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.
280		433
281	=back	434	=back
282		435
283	=head2 RENDITION	436	=head2 RENDITION
284		437
…		…
311		464
312	=item $background = urxvt::GET_BASEBG $rend	465	=item $background = urxvt::GET_BASEBG $rend
313		466
314	Return the foreground/background colour index, respectively.	467	Return the foreground/background colour index, respectively.
315		468
316	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
317		470
318	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
319		472
320	Replace the foreground/background colour in the rendition mask with the	473	Replace the foreground/background colour in the rendition mask with the
321	specified one.	474	specified one.
322		475
323	=item $value = urxvt::GET_CUSTOM ($rend)	476	=item $value = urxvt::GET_CUSTOM $rend
324		477
325	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
326	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
327	zero.	480	zero.
328		481
329	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	482	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
330		483
331	Change the custom value.	484	Change the custom value.
332		485
333	=back	486	=back
334		487
335	=cut	488	=cut
336
337	package urxvt;
338
339	use strict;
340	use Scalar::Util ();
341
342	our $TERM;
343	our @HOOKNAME;
344	our $LIBDIR;
345		489
346	BEGIN {	490	BEGIN {
347	urxvt->bootstrap;	491	urxvt->bootstrap;
348		492
349	# overwrite perl's warn	493	# overwrite perl's warn
…		…
351	my $msg = join "", @_;	495	my $msg = join "", @_;
352	$msg .= "\n"	496	$msg .= "\n"
353	unless $msg =~ /\n$/;	497	unless $msg =~ /\n$/;
354	urxvt::warn ($msg);	498	urxvt::warn ($msg);
355	};	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";
356	}	506	}
357		507
358	my @hook_count;	508	my @hook_count;
359	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	509	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
360		510
361	sub verbose {	511	sub verbose {
362	my ($level, $msg) = @_;	512	my ($level, $msg) = @_;
363	warn "$msg\n" if $level <= $verbosity;	513	warn "$msg\n" if $level <= $verbosity;
364	}	514	}
365		515
366	# find on_xxx subs in the package and register them	516	my $extension_pkg = "extension0000";
367	# as hooks	517	my %extension_pkg;
368	sub register_package($) {
369	my ($pkg) = @_;
370
371	for my $htype (0.. $#HOOKNAME) {
372	my $name = $HOOKNAME[$htype];
373
374	my $ref = $pkg->can ("on_" . lc $name)
375	or next;
376
377	$TERM->{_hook}[$htype]{$pkg} = $ref;
378	$hook_count[$htype]++
379	or set_should_invoke $htype, 1;
380	}
381	}
382
383	my $script_pkg = "script0000";
384	my %script_pkg;
385		518
386	# load a single script into its own package, once only	519	# load a single script into its own package, once only
387	sub script_package($) {	520	sub extension_package($) {
388	my ($path) = @_;	521	my ($path) = @_;
389		522
390	$script_pkg{$path} \|\|= do {	523	$extension_pkg{$path} \|\|= do {
391	my $pkg = "urxvt::" . ($script_pkg++);	524	my $pkg = "urxvt::" . ($extension_pkg++);
392		525
393	verbose 3, "loading script '$path' into package '$pkg'";	526	verbose 3, "loading extension '$path' into package '$pkg'";
394		527
395	open my $fh, "<:raw", $path	528	open my $fh, "<:raw", $path
396	or die "$path: $!";	529	or die "$path: $!";
397		530
		531	my $source = untaint
398	my $source = "package $pkg; use strict; use utf8;\n"	532	"package $pkg; use strict; use utf8;\n"
		533	. "use base urxvt::term::extension::;\n"
399	. "#line 1 \"$path\"\n{\n"	534	. "#line 1 \"$path\"\n{\n"
400	. (do { local $/; <$fh> })	535	. (do { local $/; <$fh> })
401	. "\n};\n1";	536	. "\n};\n1";
402		537
		538	eval $source
403	eval $source or die "$path: $@";	539	or die "$path: $@";
404		540
405	$pkg	541	$pkg
406	}	542	}
407	}	543	}
408		544
…		…
413	local $TERM = shift;	549	local $TERM = shift;
414	my $htype = shift;	550	my $htype = shift;
415		551
416	if ($htype == 0) { # INIT	552	if ($htype == 0) { # INIT
417	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	553	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		554
		555	my %ext_arg;
418		556
419	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) {
420	my @files = grep -f $_, map "$_/$ext", @dirs;	570	my @files = grep -f $_, map "$_/$ext", @dirs;
421		571
422	if (@files) {	572	if (@files) {
423	register_package script_package $files[0];	573	$TERM->register_package (extension_package $files[0], $argv);
424	} else {	574	} else {
425	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";
426	}	576	}
427	}	577	}
		578
		579	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		580	warn $@ if $@;
428	}	581	}
429		582
430	$retval = undef;	583	$retval = undef;
431		584
432	if (my $cb = $TERM->{_hook}[$htype]) {	585	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
434	if $verbosity >= 10;	587	if $verbosity >= 10;
435		588
436	keys %$cb;	589	keys %$cb;
437		590
438	while (my ($pkg, $cb) = each %$cb) {	591	while (my ($pkg, $cb) = each %$cb) {
439	$retval = $cb->(	592	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
440	$TERM->{_pkg}{$pkg} \|\|= do {
441	my $proxy = bless { }, urxvt::term::proxy::;
442	Scalar::Util::weaken ($proxy->{term} = $TERM);
443	$proxy
444	},
445	@_,
446	) and last;	593	and last;
		594
		595	if ($@) {
		596	$TERM->ungrab; # better to lose the grab than the session
		597	warn $@;
		598	}
447	}	599	}
448	}	600	}
449		601
450	if ($htype == 1) { # DESTROY	602	if ($htype == 1) { # DESTROY
451	# remove hooks if unused
452	if (my $hook = $TERM->{_hook}) {	603	if (my $hook = delete $TERM->{_hook}) {
453	for my $htype (0..$#$hook) {	604	for my $htype (0..$#$hook) {
454	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	605	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
455	or set_should_invoke $htype, 0;	606	or set_should_invoke $htype, 0;
456	}	607	}
457	}	608	}
…		…
464	}	615	}
465		616
466	$retval	617	$retval
467	}	618	}
468		619
469	sub urxvt::term::proxy::AUTOLOAD {	620	sub exec_async(@) {
470	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	621	my $pid = fork;
		622
		623	return
		624	if !defined $pid or $pid;
		625
		626	%ENV = %{ $TERM->env };
		627
		628	exec @_;
		629	_exit 255;
		630	}
		631
		632	# urxvt::term::extension
		633
		634	package urxvt::term::extension;
		635
		636	sub enable {
		637	my ($self, %hook) = @_;
		638	my $pkg = $self->{_pkg};
		639
		640	while (my ($name, $cb) = each %hook) {
		641	my $htype = $HOOKTYPE{uc $name};
		642	defined $htype
		643	or Carp::croak "unsupported hook type '$name'";
		644
		645	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		646	$hook_count[$htype]++
		647	or urxvt::set_should_invoke $htype, 1;
		648	}
		649
		650	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		651	}
		652	}
		653
		654	sub disable {
		655	my ($self, @hook) = @_;
		656	my $pkg = $self->{_pkg};
		657
		658	for my $name (@hook) {
		659	my $htype = $HOOKTYPE{uc $name};
		660	defined $htype
		661	or Carp::croak "unsupported hook type '$name'";
		662
		663	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		664	--$hook_count[$htype]
		665	or urxvt::set_should_invoke $htype, 0;
		666	}
		667	}
		668	}
		669
		670	our $AUTOLOAD;
		671
		672	sub AUTOLOAD {
		673	$AUTOLOAD =~ /:([^:]+)$/
471	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	674	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
472		675
473	eval qq{	676	eval qq{
474	sub $urxvt::term::proxy::AUTOLOAD {	677	sub $AUTOLOAD {
475	my \$proxy = shift;	678	my \$proxy = shift;
476	\$proxy->{term}->$1 (\@_)	679	\$proxy->{term}->$1 (\@_)
477	}	680	}
478	1	681	1
479	} or die "FATAL: unable to compile method forwarder: $@";	682	} or die "FATAL: unable to compile method forwarder: $@";
480		683
481	goto &$urxvt::term::proxy::AUTOLOAD;	684	goto &$AUTOLOAD;
482	}	685	}
		686
		687	sub DESTROY {
		688	# nop
		689	}
		690
		691	# urxvt::destroy_hook
		692
		693	sub urxvt::destroy_hook::DESTROY {
		694	${$_[0]}->();
		695	}
		696
		697	sub urxvt::destroy_hook(&) {
		698	bless \shift, urxvt::destroy_hook::
		699	}
		700
		701	package urxvt::anyevent;
		702
		703	=head2 The C<urxvt::anyevent> Class
		704
		705	The sole purpose of this class is to deliver an interface to the
		706	C<AnyEvent> module - any module using it will work inside urxvt without
		707	further programming. The only exception is that you cannot wait on
		708	condition variables, but non-blocking condvar use is ok. What this means
		709	is that you cannot use blocking APIs, but the non-blocking variant should
		710	work.
		711
		712	=cut
		713
		714	our $VERSION = 1;
		715
		716	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		717	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		718
		719	sub timer {
		720	my ($class, %arg) = @_;
		721
		722	my $cb = $arg{cb};
		723
		724	urxvt::timer
		725	->new
		726	->start (urxvt::NOW + $arg{after})
		727	->cb (sub {
		728	$_[0]->stop; # need to cancel manually
		729	$cb->();
		730	})
		731	}
		732
		733	sub io {
		734	my ($class, %arg) = @_;
		735
		736	my $cb = $arg{cb};
		737
		738	bless [$arg{fh}, urxvt::iow
		739	->new
		740	->fd (fileno $arg{fh})
		741	->events (($arg{poll} =~ /r/ ? 1 : 0)
		742	\| ($arg{poll} =~ /w/ ? 2 : 0))
		743	->start
		744	->cb (sub {
		745	$cb->(($_[1] & 1 ? 'r' : '')
		746	. ($_[1] & 2 ? 'w' : ''));
		747	})],
		748	urxvt::anyevent::
		749	}
		750
		751	sub DESTROY {
		752	$_[0][1]->stop;
		753	}
		754
		755	sub condvar {
		756	bless \my $flag, urxvt::anyevent::condvar::
		757	}
		758
		759	sub urxvt::anyevent::condvar::broadcast {
		760	${$_[0]}++;
		761	}
		762
		763	sub urxvt::anyevent::condvar::wait {
		764	unless (${$_[0]}) {
		765	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		766	}
		767	}
		768
		769	package urxvt::term;
483		770
484	=head2 The C<urxvt::term> Class	771	=head2 The C<urxvt::term> Class
485		772
486	=over 4	773	=over 4
		774
		775	=cut
		776
		777	# find on_xxx subs in the package and register them
		778	# as hooks
		779	sub register_package {
		780	my ($self, $pkg, $argv) = @_;
		781
		782	my $proxy = bless {
		783	_pkg => $pkg,
		784	argv => $argv,
		785	}, $pkg;
		786	Scalar::Util::weaken ($proxy->{term} = $self);
		787
		788	$self->{_pkg}{$pkg} = $proxy;
		789
		790	for my $name (@HOOKNAME) {
		791	if (my $ref = $pkg->can ("on_" . lc $name)) {
		792	$proxy->enable ($name => $ref);
		793	}
		794	}
		795	}
		796
		797	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		798
		799	Creates a new terminal, very similar as if you had started it with system
		800	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		801	hash which defines the environment of the new terminal.
		802
		803	Croaks (and probably outputs an error message) if the new instance
		804	couldn't be created. Returns C<undef> if the new instance didn't
		805	initialise perl, and the terminal object otherwise. The C<init> and
		806	C<start> hooks will be called during this call.
		807
		808	=cut
		809
		810	sub new {
		811	my ($class, $env, @args) = @_;
		812
		813	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		814	}
		815
		816	=item $term->destroy
		817
		818	Destroy the terminal object (close the window, free resources
		819	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		820	watchers (timers, io watchers) are still active.
		821
		822	=item $isset = $term->option ($optval[, $set])
		823
		824	Returns true if the option specified by C<$optval> is enabled, and
		825	optionally change it. All option values are stored by name in the hash
		826	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		827
		828	Here is a a likely non-exhaustive list of option names, please see the
		829	source file F</src/optinc.h> to see the actual list:
		830
		831	borderLess console cursorBlink cursorUnderline hold iconic insecure
		832	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		833	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		834	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		835	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		836	tripleclickwords utmpInhibit visualBell
487		837
488	=item $value = $term->resource ($name[, $newval])	838	=item $value = $term->resource ($name[, $newval])
489		839
490	Returns the current resource value associated with a given name and	840	Returns the current resource value associated with a given name and
491	optionally sets a new value. Setting values is most useful in the C<init>	841	optionally sets a new value. Setting values is most useful in the C<init>
…		…
501		851
502	Please note that resource strings will currently only be freed when the	852	Please note that resource strings will currently only be freed when the
503	terminal is destroyed, so changing options frequently will eat memory.	853	terminal is destroyed, so changing options frequently will eat memory.
504		854
505	Here is a a likely non-exhaustive list of resource names, not all of which	855	Here is a a likely non-exhaustive list of resource names, not all of which
506	are supported in every build, please see the source to see the actual	856	are supported in every build, please see the source file F</src/rsinc.h>
507	list:	857	to see the actual list:
508		858
509	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	859	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
510	borderLess color cursorBlink cursorUnderline cutchars delete_key	860	borderLess color cursorBlink cursorUnderline cutchars delete_key
511	display_name embed ext_bwidth fade font geometry hold iconName	861	display_name embed ext_bwidth fade font geometry hold iconName
512	imFont imLocale inputMethod insecure int_bwidth intensityStyles	862	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
519	shade term_name title transparent transparent_all tripleclickwords	869	shade term_name title transparent transparent_all tripleclickwords
520	utmpInhibit visualBell	870	utmpInhibit visualBell
521		871
522	=cut	872	=cut
523		873
524	sub urxvt::term::resource($$;$) {	874	sub resource($$;$) {
525	my ($self, $name) = (shift, shift);	875	my ($self, $name) = (shift, shift);
526	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	876	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
527	goto &urxvt::term::_resource;	877	&urxvt::term::_resource
528	}	878	}
		879
		880	=item $value = $term->x_resource ($pattern)
		881
		882	Returns the X-Resource for the given pattern, excluding the program or
		883	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		884	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		885	resource with that pattern exists.
		886
		887	This method should only be called during the C<on_start> hook, as there is
		888	only one resource database per display, and later invocations might return
		889	the wrong resources.
		890
		891	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		892
		893	Adds a keymap translation exactly as specified via a resource. See the
		894	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
529		895
530	=item $rend = $term->rstyle ([$new_rstyle])	896	=item $rend = $term->rstyle ([$new_rstyle])
531		897
532	Return and optionally change the current rendition. Text that is output by	898	Return and optionally change the current rendition. Text that is output by
533	the terminal application will use this style.	899	the terminal application will use this style.
…		…
553		919
554	=item $oldtext = $term->selection ([$newtext])	920	=item $oldtext = $term->selection ([$newtext])
555		921
556	Return the current selection text and optionally replace it by C<$newtext>.	922	Return the current selection text and optionally replace it by C<$newtext>.
557		923
558	#=item $term->overlay ($x, $y, $text)	924	=item $term->overlay_simple ($x, $y, $text)
559	#	925
560	#Create a simple multi-line overlay box. See the next method for details.	926	Create a simple multi-line overlay box. See the next method for details.
561	#	927
562	#=cut	928	=cut
563	#	929
564	#sub urxvt::term::scr_overlay {	930	sub overlay_simple {
565	# my ($self, $x, $y, $text) = @_;	931	my ($self, $x, $y, $text) = @_;
566	#	932
567	# my @lines = split /\n/, $text;	933	my @lines = split /\n/, $text;
568	#	934
569	# my $w = 0;	935	my $w = List::Util::max map $self->strwidth ($_), @lines;
570	# for (map $self->strwidth ($_), @lines) {	936
571	# $w = $_ if $w < $_;
572	# }
573	#
574	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	937	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
575	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	938	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
576	#}	939
		940	$overlay
		941	}
577		942
578	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	943	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
579		944
580	Create a new (empty) overlay at the given position with the given	945	Create a new (empty) overlay at the given position with the given
581	width/height. C<$rstyle> defines the initial rendition style	946	width/height. C<$rstyle> defines the initial rendition style
…		…
608		973
609	If hidden, display the overlay again.	974	If hidden, display the overlay again.
610		975
611	=back	976	=back
612		977
		978	=item $popup = $term->popup ($event)
		979
		980	Creates a new C<urxvt::popup> object that implements a popup menu. The
		981	C<$event> I<must> be the event causing the menu to pop up (a button event,
		982	currently).
		983
		984	=cut
		985
		986	sub popup {
		987	my ($self, $event) = @_;
		988
		989	$self->grab ($event->{time}, 1)
		990	or return;
		991
		992	my $popup = bless {
		993	term => $self,
		994	event => $event,
		995	}, urxvt::popup::;
		996
		997	Scalar::Util::weaken $popup->{term};
		998
		999	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1000	Scalar::Util::weaken $self->{_destroy}{$popup};
		1001
		1002	$popup
		1003	}
		1004
613	=item $cellwidth = $term->strwidth $string	1005	=item $cellwidth = $term->strwidth ($string)
614		1006
615	Returns the number of screen-cells this string would need. Correctly	1007	Returns the number of screen-cells this string would need. Correctly
616	accounts for wide and combining characters.	1008	accounts for wide and combining characters.
617		1009
618	=item $octets = $term->locale_encode $string	1010	=item $octets = $term->locale_encode ($string)
619		1011
620	Convert the given text string into the corresponding locale encoding.	1012	Convert the given text string into the corresponding locale encoding.
621		1013
622	=item $string = $term->locale_decode $octets	1014	=item $string = $term->locale_decode ($octets)
623		1015
624	Convert the given locale-encoded octets into a perl string.	1016	Convert the given locale-encoded octets into a perl string.
		1017
		1018	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1019
		1020	XORs the rendition values in the given span with the provided value
		1021	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		1022	to the selection.
		1023
		1024	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1025
		1026	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1027	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1028	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1029	it instead.
		1030
		1031	=item $term->scr_bell
		1032
		1033	Ring the bell!
625		1034
626	=item $term->scr_add_lines ($string)	1035	=item $term->scr_add_lines ($string)
627		1036
628	Write the given text string to the screen, as if output by the application	1037	Write the given text string to the screen, as if output by the application
629	running inside the terminal. It may not contain command sequences (escape	1038	running inside the terminal. It may not contain command sequences (escape
…		…
632		1041
633	Normally its not a good idea to use this function, as programs might be	1042	Normally its not a good idea to use this function, as programs might be
634	confused by changes in cursor position or scrolling. Its useful inside a	1043	confused by changes in cursor position or scrolling. Its useful inside a
635	C<on_add_lines> hook, though.	1044	C<on_add_lines> hook, though.
636		1045
		1046	=item $term->cmd_parse ($octets)
		1047
		1048	Similar to C<scr_add_lines>, but the argument must be in the
		1049	locale-specific encoding of the terminal and can contain command sequences
		1050	(escape codes) that will be interpreted.
		1051
637	=item $term->tt_write ($octets)	1052	=item $term->tt_write ($octets)
638		1053
639	Write the octets given in C<$data> to the tty (i.e. as program input). To	1054	Write the octets given in C<$data> to the tty (i.e. as program input). To
640	pass characters instead of octets, you should convert your strings first	1055	pass characters instead of octets, you should convert your strings first
641	to the locale-specific encoding using C<< $term->locale_encode >>.	1056	to the locale-specific encoding using C<< $term->locale_encode >>.
642		1057
		1058	=item $old_events = $term->pty_ev_events ([$new_events])
		1059
		1060	Replaces the event mask of the pty watcher by the given event mask. Can
		1061	be used to suppress input and output handling to the pty/tty. See the
		1062	description of C<< urxvt::timer->events >>. Make sure to always restore
		1063	the previous value.
		1064
		1065	=item $windowid = $term->parent
		1066
		1067	Return the window id of the toplevel window.
		1068
		1069	=item $windowid = $term->vt
		1070
		1071	Return the window id of the terminal window.
		1072
643	=item $window_width = $term->width	1073	=item $window_width = $term->width
644		1074
645	=item $window_height = $term->height	1075	=item $window_height = $term->height
646		1076
647	=item $font_width = $term->fwidth	1077	=item $font_width = $term->fwidth
…		…
663	=item $nrow_plus_saveLines = $term->total_rows	1093	=item $nrow_plus_saveLines = $term->total_rows
664		1094
665	=item $lines_in_scrollback = $term->nsaved	1095	=item $lines_in_scrollback = $term->nsaved
666		1096
667	Return various integers describing terminal characteristics.	1097	Return various integers describing terminal characteristics.
		1098
		1099	=item $x_display = $term->display_id
		1100
		1101	Return the DISPLAY used by rxvt-unicode.
		1102
		1103	=item $lc_ctype = $term->locale
		1104
		1105	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1106
		1107	=item $env = $term->env
		1108
		1109	Returns a copy of the environment in effect for the terminal as a hashref
		1110	similar to C<\%ENV>.
		1111
		1112	=cut
		1113
		1114	sub env {
		1115	if (my $env = $_[0]->_env) {
		1116	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1117	} else {
		1118	+{ %ENV }
		1119	}
		1120	}
		1121
		1122	=item $modifiermask = $term->ModLevel3Mask
		1123
		1124	=item $modifiermask = $term->ModMetaMask
		1125
		1126	=item $modifiermask = $term->ModNumLockMask
		1127
		1128	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1129	AltGr), the meta key (often Alt) and the num lock key, if applicable.
668		1130
669	=item $view_start = $term->view_start ([$newvalue])	1131	=item $view_start = $term->view_start ([$newvalue])
670		1132
671	Returns the negative row number of the topmost line. Minimum value is	1133	Returns the negative row number of the topmost line. Minimum value is
672	C<0>, which displays the normal terminal contents. Larger values scroll	1134	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
735	about the logical line that row C<$row_number> is part of. It supports the	1197	about the logical line that row C<$row_number> is part of. It supports the
736	following methods:	1198	following methods:
737		1199
738	=over 4	1200	=over 4
739		1201
740	=item $text = $line->t	1202	=item $text = $line->t ([$new_text])
741		1203
742	Returns the full text of the line, similar to C<ROW_t>	1204	Returns or replaces the full text of the line, similar to C<ROW_t>
743		1205
744	=item $rend = $line->r	1206	=item $rend = $line->r ([$new_rend])
745		1207
746	Returns the full rendition array of the line, similar to C<ROW_r>	1208	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
747		1209
748	=item $length = $line->l	1210	=item $length = $line->l
749		1211
750	Returns the length of the line in cells, similar to C<ROW_l>.	1212	Returns the length of the line in cells, similar to C<ROW_l>.
751		1213
…		…
766		1228
767	=back	1229	=back
768		1230
769	=cut	1231	=cut
770		1232
771	sub urxvt::term::line {	1233	sub line {
772	my ($self, $row) = @_;	1234	my ($self, $row) = @_;
773		1235
774	my $maxrow = $self->nrow - 1;	1236	my $maxrow = $self->nrow - 1;
775		1237
776	my ($beg, $end) = ($row, $row);	1238	my ($beg, $end) = ($row, $row);
…		…
780		1242
781	bless {	1243	bless {
782	term => $self,	1244	term => $self,
783	beg => $beg,	1245	beg => $beg,
784	end => $end,	1246	end => $end,
		1247	ncol => $self->ncol,
785	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1248	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
786	}, urxvt::line::	1249	}, urxvt::line::
787	}	1250	}
788		1251
789	sub urxvt::line::t {	1252	sub urxvt::line::t {
790	my ($self) = @_;	1253	my ($self) = @_;
791		1254
		1255	if (@_ > 1)
		1256	{
		1257	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1258	for $self->{beg} .. $self->{end};
		1259	}
		1260
		1261	defined wantarray &&
792	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1262	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
793	0, $self->{len}	1263	0, $self->{len}
794	}	1264	}
795		1265
796	sub urxvt::line::r {	1266	sub urxvt::line::r {
797	my ($self) = @_;	1267	my ($self) = @_;
798		1268
		1269	if (@_ > 1)
		1270	{
		1271	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1272	for $self->{beg} .. $self->{end};
		1273	}
		1274
		1275	if (defined wantarray) {
799	my $rend = [	1276	my $rend = [
800	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1277	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
801	];	1278	];
802	$#$rend = $self->{len} - 1;	1279	$#$rend = $self->{len} - 1;
803	$rend	1280	return $rend;
		1281	}
		1282
		1283	()
804	}	1284	}
805		1285
806	sub urxvt::line::beg { $_[0]{beg} }	1286	sub urxvt::line::beg { $_[0]{beg} }
807	sub urxvt::line::end { $_[0]{end} }	1287	sub urxvt::line::end { $_[0]{end} }
808	sub urxvt::line::l { $_[0]{len} }	1288	sub urxvt::line::l { $_[0]{len} }
809		1289
810	sub urxvt::line::offset_of {	1290	sub urxvt::line::offset_of {
811	my ($self, $row, $col) = @_;	1291	my ($self, $row, $col) = @_;
812		1292
813	($row - $self->{beg}) * $self->{term}->ncol + $col	1293	($row - $self->{beg}) * $self->{ncol} + $col
814	}	1294	}
815		1295
816	sub urxvt::line::coord_of {	1296	sub urxvt::line::coord_of {
817	my ($self, $offset) = @_;	1297	my ($self, $offset) = @_;
818		1298
819	use integer;	1299	use integer;
820		1300
821	(	1301	(
822	$offset / $self->{term}->ncol + $self->{beg},	1302	$offset / $self->{ncol} + $self->{beg},
823	$offset % $self->{term}->ncol	1303	$offset % $self->{ncol}
824	)	1304	)
825	}	1305	}
826		1306
827	=item ($row, $col) = $line->coord_of ($offset)
828	=item $text = $term->special_encode $string	1307	=item $text = $term->special_encode $string
829		1308
830	Converts a perl string into the special encoding used by rxvt-unicode,	1309	Converts a perl string into the special encoding used by rxvt-unicode,
831	where one character corresponds to one screen cell. See	1310	where one character corresponds to one screen cell. See
832	C<< $term->ROW_t >> for details.	1311	C<< $term->ROW_t >> for details.
833		1312
834	=item $string = $term->special_decode $text	1313	=item $string = $term->special_decode $text
835		1314
836	Converts rxvt-unicodes text reprsentation into a perl string. See	1315	Converts rxvt-unicodes text reprsentation into a perl string. See
837	C<< $term->ROW_t >> for details.	1316	C<< $term->ROW_t >> for details.
		1317
		1318	=item $success = $term->grab_button ($button, $modifiermask)
		1319
		1320	Registers a synchronous button grab. See the XGrabButton manpage.
		1321
		1322	=item $success = $term->grab ($eventtime[, $sync])
		1323
		1324	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1325	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1326
		1327	=item $term->allow_events_async
		1328
		1329	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1330
		1331	=item $term->allow_events_sync
		1332
		1333	Calls XAllowEvents with SyncBoth for the most recent grab.
		1334
		1335	=item $term->allow_events_replay
		1336
		1337	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1338	recent grab.
		1339
		1340	=item $term->ungrab
		1341
		1342	Calls XUngrab for the most recent grab. Is called automatically on
		1343	evaluation errors, as it is better to lose the grab in the error case as
		1344	the session.
		1345
		1346	=back
		1347
		1348	=cut
		1349
		1350	package urxvt::popup;
		1351
		1352	=head2 The C<urxvt::popup> Class
		1353
		1354	=over 4
		1355
		1356	=cut
		1357
		1358	sub add_item {
		1359	my ($self, $item) = @_;
		1360
		1361	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1362	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1363	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1364
		1365	$item->{render} \|\|= sub { $_[0]{text} };
		1366
		1367	push @{ $self->{item} }, $item;
		1368	}
		1369
		1370	=item $popup->add_title ($title)
		1371
		1372	Adds a non-clickable title to the popup.
		1373
		1374	=cut
		1375
		1376	sub add_title {
		1377	my ($self, $title) = @_;
		1378
		1379	$self->add_item ({
		1380	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1381	text => $title,
		1382	activate => sub { },
		1383	});
		1384	}
		1385
		1386	=item $popup->add_separator ([$sepchr])
		1387
		1388	Creates a separator, optionally using the character given as C<$sepchr>.
		1389
		1390	=cut
		1391
		1392	sub add_separator {
		1393	my ($self, $sep) = @_;
		1394
		1395	$sep \|\|= "=";
		1396
		1397	$self->add_item ({
		1398	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1399	text => "",
		1400	render => sub { $sep x $self->{term}->ncol },
		1401	activate => sub { },
		1402	});
		1403	}
		1404
		1405	=item $popup->add_button ($text, $cb)
		1406
		1407	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1408	selected.
		1409
		1410	=cut
		1411
		1412	sub add_button {
		1413	my ($self, $text, $cb) = @_;
		1414
		1415	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1416	}
		1417
		1418	=item $popup->add_toggle ($text, $cb, $initial_value)
		1419
		1420	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1421	whenever it gets toggled, with a boolean indicating its value as its first
		1422	argument.
		1423
		1424	=cut
		1425
		1426	sub add_toggle {
		1427	my ($self, $text, $cb, $value) = @_;
		1428
		1429	my $item; $item = {
		1430	type => "button",
		1431	text => " $text",
		1432	value => $value,
		1433	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1434	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1435	};
		1436
		1437	$self->add_item ($item);
		1438	}
		1439
		1440	=item $popup->show
		1441
		1442	Displays the popup (which is initially hidden).
		1443
		1444	=cut
		1445
		1446	sub show {
		1447	my ($self) = @_;
		1448
		1449	local $urxvt::popup::self = $self;
		1450
		1451	my $env = $self->{term}->env;
		1452	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1453	delete $env->{LC_ALL};
		1454	$env->{LC_CTYPE} = $self->{term}->locale;
		1455
		1456	urxvt::term->new ($env, $self->{term}->resource ("name"),
		1457	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1458	"--transient-for" => $self->{term}->parent,
		1459	"-display" => $self->{term}->display_id,
		1460	"-pe" => "urxvt-popup")
		1461	or die "unable to create popup window\n";
		1462	}
		1463
		1464	sub DESTROY {
		1465	my ($self) = @_;
		1466
		1467	delete $self->{term}{_destroy}{$self};
		1468	$self->{term}->ungrab;
		1469	}
838		1470
839	=back	1471	=back
840		1472
841	=head2 The C<urxvt::timer> Class	1473	=head2 The C<urxvt::timer> Class
842		1474
…		…
897		1529
898	$term->{socket} = ...	1530	$term->{socket} = ...
899	$term->{iow} = urxvt::iow	1531	$term->{iow} = urxvt::iow
900	->new	1532	->new
901	->fd (fileno $term->{socket})	1533	->fd (fileno $term->{socket})
902	->events (1) # wait for read data	1534	->events (urxvt::EVENT_READ)
903	->start	1535	->start
904	->cb (sub {	1536	->cb (sub {
905	my ($iow, $revents) = @_;	1537	my ($iow, $revents) = @_;
906	# $revents must be 1 here, no need to check	1538	# $revents must be 1 here, no need to check
907	sysread $term->{socket}, my $buf, 8192	1539	sysread $term->{socket}, my $buf, 8192
…		…
924		1556
925	Set the filedescriptor (not handle) to watch.	1557	Set the filedescriptor (not handle) to watch.
926		1558
927	=item $iow = $iow->events ($eventmask)	1559	=item $iow = $iow->events ($eventmask)
928		1560
929	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1561	Set the event mask to watch. The only allowed values are
930	data, Bit #1 (value C<2>) enables watching for write data.	1562	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1563	together, or C<urxvt::EVENT_NONE>.
931		1564
932	=item $iow = $iow->start	1565	=item $iow = $iow->start
933		1566
934	Start watching for requested events on the given handle.	1567	Start watching for requested events on the given handle.
935		1568
…		…
946	This variable controls the verbosity level of the perl extension. Higher	1579	This variable controls the verbosity level of the perl extension. Higher
947	numbers indicate more verbose output.	1580	numbers indicate more verbose output.
948		1581
949	=over 4	1582	=over 4
950		1583
951	=item =0 - only fatal messages	1584	=item == 0 - fatal messages
952		1585
953	=item =3 - script loading and management	1586	=item >= 3 - script loading and management
954		1587
955	=item =10 - all events received	1588	=item >=10 - all events received
956		1589
957	=back	1590	=back
958		1591
959	=head1 AUTHOR	1592	=head1 AUTHOR
960		1593

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC vs. Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC vs.
Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC