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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.42 by root, Fri Jan 6 21:06:09 2006 UTC vs.
Revision 1.91 by root, Fri Jan 13 01:09:37 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 and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	47	arguments, which is very convenient, too, if your F<ls> supports
		48	C<--quoting-style=shell>.
48		49
49	It also offers the following bindable event:	50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
		53	The selection works by trying to match a number of regexes and displaying
		54	them in increasing order of length. You can add your own regexes by
		55	specifying resources of the form:
		56
		57	URxvt.selection.pattern-0: perl-regex
		58	URxvt.selection.pattern-1: perl-regex
		59	...
		60
		61	The index number (0, 1...) must not have any holes, and each regex must
		62	contain at least one pair of capturing parentheses, which will be used for
		63	the match. For example, the followign adds a regex that matches everything
		64	between two vertical bars:
		65
		66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		67
		68	You can look at the source of the selection extension to see more
		69	interesting uses, such as parsing a line from beginning to end.
		70
		71	This extension also offers the following bindable keyboard command:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
…		…
56		78
57	URxvt.keysym.C-M-r: perl:selection:rot13	79	URxvt.keysym.C-M-r: perl:selection:rot13
58		80
59	=back	81	=back
60		82
61	=item digital-clock	83	=item option-popup (enabled by default)
62		84
63	Displays a digital clock using the built-in overlay.	85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		86	runtime.
		87
		88	=item selection-popup (enabled by default)
		89
		90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
		93
		94	=item searchable-scrollback<hotkey> (enabled by default)
		95
		96	Adds regex search functionality to the scrollback buffer, triggered
		97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		98	input/output is suspended and a regex is displayed at the bottom of the
		99	screen.
		100
		101	Inputting characters appends them to the regex and continues incremental
		102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		104	bottom. C<Escape> leaves search mode and returns to the point where search
		105	was started, while C<Enter> or C<Return> stay at the current position and
		106	additionally stores the first match in the current line into the primary
		107	selection.
		108
		109	=item selection-autotransform
		110
		111	This selection allows you to do automatic transforms on a selection
		112	whenever a selection is made.
		113
		114	It works by specifying perl snippets (most useful is a single C<s///>
		115	operator) that modify C<$_> as resources:
		116
		117	URxvt.selection-autotransform.0: transform
		118	URxvt.selection-autotransform.1: transform
		119	...
		120
		121	For example, the following will transform selections of the form
		122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		123	$word>:
		124
		125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		126
		127	And this example matches the same,but replaces it with vi-commands you can
		128	paste directly into your (vi :) editor:
		129
		130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		131
		132	Of course, this can be modified to suit your needs and your editor :)
		133
		134	To expand the example above to typical perl error messages ("XXX at
		135	FILENAME line YYY."), you need a slightly more elaborate solution:
		136
		137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		139
		140	The first line tells the selection code to treat the unchanging part of
		141	every error message as a selection pattern, and the second line transforms
		142	the message into vi commands to load the file.
64		143
65	=item mark-urls	144	=item mark-urls
66		145
67	Uses per-line display filtering (C<on_line_update>) to underline urls.	146	Uses per-line display filtering (C<on_line_update>) to underline urls and
		147	make them clickable. When middle-clicked, the program specified in the
		148	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		149	the URL as first argument.
68		150
69	=item block-graphics-to-ascii	151	=item block-graphics-to-ascii
70		152
71	A not very useful example of filtering all text output to the terminal,	153	A not very useful example of filtering all text output to the terminal,
72	by replacing all line-drawing characters (U+2500 .. U+259F) by a	154	by replacing all line-drawing characters (U+2500 .. U+259F) by a
73	similar-looking ascii character.	155	similar-looking ascii character.
74		156
		157	=item digital-clock
		158
		159	Displays a digital clock using the built-in overlay.
		160
75	=item example-refresh-hooks	161	=item example-refresh-hooks
76		162
77	Displays a very simple digital clock in the upper right corner of the	163	Displays a very simple digital clock in the upper right corner of the
78	window. Illustrates overwriting the refresh callbacks to create your own	164	window. Illustrates overwriting the refresh callbacks to create your own
79	overlays or changes.	165	overlays or changes.
80		166
81	=back	167	=back
		168
		169	=head1 API DOCUMENTATION
82		170
83	=head2 General API Considerations	171	=head2 General API Considerations
84		172
85	All objects (such as terminals, time watchers etc.) are typical	173	All objects (such as terminals, time watchers etc.) are typical
86	reference-to-hash objects. The hash can be used to store anything you	174	reference-to-hash objects. The hash can be used to store anything you
…		…
99	=over 4	187	=over 4
100		188
101	=item $text	189	=item $text
102		190
103	Rxvt-unicodes special way of encoding text, where one "unicode" character	191	Rxvt-unicodes special way of encoding text, where one "unicode" character
104	always represents one screen cell. See L<row_t> for a discussion of this format.	192	always represents one screen cell. See L<ROW_t> for a discussion of this format.
105		193
106	=item $string	194	=item $string
107		195
108	A perl text string, with an emphasis on I<text>. It can store all unicode	196	A perl text string, with an emphasis on I<text>. It can store all unicode
109	characters and is to be distinguished with text encoded in a specific	197	characters and is to be distinguished with text encoded in a specific
…		…
114	Either binary data or - more common - a text string encoded in a	202	Either binary data or - more common - a text string encoded in a
115	locale-specific way.	203	locale-specific way.
116		204
117	=back	205	=back
118		206
		207	=head2 Extension Objects
		208
		209	Very perl extension is a perl class. A separate perl object is created
		210	for each terminal and each extension and passed as the first parameter to
		211	hooks. So extensions can use their C<$self> object without having to think
		212	about other extensions, with the exception of methods and members that
		213	begin with an underscore character C<_>: these are reserved for internal
		214	use.
		215
		216	Although it isn't a C<urxvt::term> object, you can call all methods of the
		217	C<urxvt::term> class on this object.
		218
		219	It has the following methods and data members:
		220
		221	=over 4
		222
		223	=item $urxvt_term = $self->{term}
		224
		225	Returns the C<urxvt::term> object associated with this instance of the
		226	extension. This member I<must not> be changed in any way.
		227
		228	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		229
		230	Dynamically enable the given hooks (named without the C<on_> prefix) for
		231	this extension, replacing any previous hook. This is useful when you want
		232	to overwrite time-critical hooks only temporarily.
		233
		234	=item $self->disable ($hook_name[, $hook_name..])
		235
		236	Dynamically disable the given hooks.
		237
		238	=back
		239
119	=head2 Hooks	240	=head2 Hooks
120		241
121	The following subroutines can be declared in loaded scripts, and will be	242	The following subroutines can be declared in extension files, and will be
122	called whenever the relevant event happens.	243	called whenever the relevant event happens.
123		244
124	The first argument passed to them is an object private to each terminal	245	The first argument passed to them is an extension oject as described in
125	and extension package. You can call all C<urxvt::term> methods on it, but	246	the in the C<Extension Objects> section.
126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127	object that is shared between all packages is stored in the C<term>
128	member.
129		247
130	All of them must return a boolean value. If it is true, then the event	248	B<All> of these hooks must return a boolean value. If it is true, then the
131	counts as being I<consumed>, and the invocation of other hooks is skipped,	249	event counts as being I<consumed>, and the invocation of other hooks is
132	and the relevant action might not be carried out by the C++ code.	250	skipped, and the relevant action might not be carried out by the C++ code.
133		251
134	When in doubt, return a false value (preferably C<()>).	252	I<< When in doubt, return a false value (preferably C<()>). >>
135		253
136	=over 4	254	=over 4
137		255
138	=item on_init $term	256	=item on_init $term
139		257
…		…
174	=item on_sel_extend $term	292	=item on_sel_extend $term
175		293
176	Called whenever the user tries to extend the selection (e.g. with a double	294	Called whenever the user tries to extend the selection (e.g. with a double
177	click) and is either supposed to return false (normal operation), or	295	click) and is either supposed to return false (normal operation), or
178	should extend the selection itelf and return true to suppress the built-in	296	should extend the selection itelf and return true to suppress the built-in
179	processing.	297	processing. This can happen multiple times, as long as the callback
		298	returns true, it will be called on every further click by the user and is
		299	supposed to enlarge the selection more and more, if possible.
180		300
181	See the F<selection> example extension.	301	See the F<selection> example extension.
182
183	=item on_focus_in $term
184
185	Called whenever the window gets the keyboard focus, before urxvt does
186	focus in processing.
187
188	=item on_focus_out $term
189
190	Called wheneever the window loses keyboard focus, before urxvt does focus
191	out processing.
192		302
193	=item on_view_change $term, $offset	303	=item on_view_change $term, $offset
194		304
195	Called whenever the view offset changes, i..e the user or program	305	Called whenever the view offset changes, i..e the user or program
196	scrolls. Offset C<0> means display the normal terminal, positive values	306	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
203	than the scroll back buffer or the terminal.	313	than the scroll back buffer or the terminal.
204		314
205	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	315	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
206	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	316	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
207	number of lines that will be in the scrollback buffer.	317	number of lines that will be in the scrollback buffer.
208
209	=item on_tty_activity $term NYI
210
211	Called whenever the program(s) running in the urxvt window send output.
212		318
213	=item on_osc_seq $term, $string	319	=item on_osc_seq $term, $string
214		320
215	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	321	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
216	operating system command) is processed. Cursor position and other state	322	operating system command) is processed. Cursor position and other state
…		…
229	can filter/change and output the text yourself by returning a true value	335	can filter/change and output the text yourself by returning a true value
230	and calling C<< $term->scr_add_lines >> yourself. Please note that this	336	and calling C<< $term->scr_add_lines >> yourself. Please note that this
231	might be very slow, however, as your hook is called for B<all> text being	337	might be very slow, however, as your hook is called for B<all> text being
232	output.	338	output.
233		339
		340	=item on_tt_write $term, $octets
		341
		342	Called whenever some data is written to the tty/pty and can be used to
		343	suppress or filter tty input.
		344
234	=item on_line_update $term, $row	345	=item on_line_update $term, $row
235		346
236	Called whenever a line was updated or changed. Can be used to filter	347	Called whenever a line was updated or changed. Can be used to filter
237	screen output (e.g. underline urls or other useless stuff). Only lines	348	screen output (e.g. underline urls or other useless stuff). Only lines
238	that are being shown will be filtered, and, due to performance reasons,	349	that are being shown will be filtered, and, due to performance reasons,
…		…
260		371
261	Called whenever the user presses a key combination that has a	372	Called whenever the user presses a key combination that has a
262	C<perl:string> action bound to it (see description of the B<keysym>	373	C<perl:string> action bound to it (see description of the B<keysym>
263	resource in the @@RXVT_NAME@@(1) manpage).	374	resource in the @@RXVT_NAME@@(1) manpage).
264		375
		376	=item on_focus_in $term
		377
		378	Called whenever the window gets the keyboard focus, before rxvt-unicode
		379	does focus in processing.
		380
		381	=item on_focus_out $term
		382
		383	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		384	focus out processing.
		385
265	=item on_key_press $term, $event, $octets	386	=item on_key_press $term, $event, $keysym, $octets
266		387
267	=item on_key_release $term, $event	388	=item on_key_release $term, $event, $keysym
268		389
269	=item on_button_press $term, $event	390	=item on_button_press $term, $event
270		391
271	=item on_button_release $term, $event	392	=item on_button_release $term, $event
272		393
273	=item on_motion_notify $term, $event	394	=item on_motion_notify $term, $event
		395
		396	=item on_map_notify $term, $event
		397
		398	=item on_unmap_notify $term, $event
274		399
275	Called whenever the corresponding X event is received for the terminal If	400	Called whenever the corresponding X event is received for the terminal If
276	the hook returns true, then the even will be ignored by rxvt-unicode.	401	the hook returns true, then the even will be ignored by rxvt-unicode.
277		402
278	The event is a hash with most values as named by Xlib (see the XEvent	403	The event is a hash with most values as named by Xlib (see the XEvent
…		…
284		409
285	subwindow.	410	subwindow.
286		411
287	=back	412	=back
288		413
		414	=cut
		415
		416	package urxvt;
		417
		418	use utf8;
		419	use strict;
		420	use Carp ();
		421	use Scalar::Util ();
		422	use List::Util ();
		423
		424	our $VERSION = 1;
		425	our $TERM;
		426	our @HOOKNAME;
		427	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		428	our %OPTION;
		429
		430	our $LIBDIR;
		431	our $RESNAME;
		432	our $RESCLASS;
		433	our $RXVTNAME;
		434
289	=head2 Variables in the C<urxvt> Package	435	=head2 Variables in the C<urxvt> Package
290		436
291	=over 4	437	=over 4
292		438
		439	=item $urxvt::LIBDIR
		440
		441	The rxvt-unicode library directory, where, among other things, the perl
		442	modules and scripts are stored.
		443
		444	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		445
		446	The resource class and name rxvt-unicode uses to look up X resources.
		447
		448	=item $urxvt::RXVTNAME
		449
		450	The basename of the installed binaries, usually C<urxvt>.
		451
293	=item $urxvt::TERM	452	=item $urxvt::TERM
294		453
295	The current terminal. Whenever a callback/Hook is bein executed, this	454	The current terminal. This variable stores the current C<urxvt::term>
296	variable stores the current C<urxvt::term> object.	455	object, whenever a callback/hook is executing.
297		456
298	=back	457	=back
299		458
300	=head2 Functions in the C<urxvt> Package	459	=head2 Functions in the C<urxvt> Package
301		460
302	=over 4	461	=over 4
303
304	=item $term = new urxvt [arg...]
305
306	Creates a new terminal, very similar as if you had started it with
307	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
308	if the new instance couldn't be created. Returns C<undef> if the new
309	instance didn't initialise perl, and the terminal object otherwise. The
310	C<init> and C<start> hooks will be called during the call.
311		462
312	=item urxvt::fatal $errormessage	463	=item urxvt::fatal $errormessage
313		464
314	Fatally aborts execution with the given error message. Avoid at all	465	Fatally aborts execution with the given error message. Avoid at all
315	costs! The only time this is acceptable is when the terminal process	466	costs! The only time this is acceptable is when the terminal process
…		…
322	that calls this function.	473	that calls this function.
323		474
324	Using this function has the advantage that its output ends up in the	475	Using this function has the advantage that its output ends up in the
325	correct place, e.g. on stderr of the connecting urxvtc client.	476	correct place, e.g. on stderr of the connecting urxvtc client.
326		477
		478	Messages have a size limit of 1023 bytes currently.
		479
		480	=item $is_safe = urxvt::safe
		481
		482	Returns true when it is safe to do potentially unsafe things, such as
		483	evaluating perl code specified by the user. This is true when urxvt was
		484	started setuid or setgid.
		485
327	=item $time = urxvt::NOW	486	=item $time = urxvt::NOW
328		487
329	Returns the "current time" (as per the event loop).	488	Returns the "current time" (as per the event loop).
		489
		490	=item urxvt::CurrentTime
		491
		492	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		493	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		494	Button4Mask, Button5Mask, AnyModifier
		495
		496	Various constants for use in X calls and event processing.
330		497
331	=back	498	=back
332		499
333	=head2 RENDITION	500	=head2 RENDITION
334		501
…		…
361		528
362	=item $background = urxvt::GET_BASEBG $rend	529	=item $background = urxvt::GET_BASEBG $rend
363		530
364	Return the foreground/background colour index, respectively.	531	Return the foreground/background colour index, respectively.
365		532
366	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	533	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
367		534
368	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	535	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
369		536
370	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
371	specified one.	538	specified one.
372		539
373	=item $value = urxvt::GET_CUSTOM ($rend)	540	=item $value = urxvt::GET_CUSTOM $rend
374		541
375	Return the "custom" value: Every rendition has 5 bits for use by	542	Return the "custom" value: Every rendition has 5 bits for use by
376	extensions. They can be set and changed as you like and are initially	543	extensions. They can be set and changed as you like and are initially
377	zero.	544	zero.
378		545
379	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	546	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
380		547
381	Change the custom value.	548	Change the custom value.
382		549
383	=back	550	=back
384		551
385	=cut	552	=cut
386
387	package urxvt;
388
389	use strict;
390	use Scalar::Util ();
391
392	our $TERM;
393	our @HOOKNAME;
394	our $LIBDIR;
395		553
396	BEGIN {	554	BEGIN {
397	urxvt->bootstrap;	555	urxvt->bootstrap;
398		556
399	# overwrite perl's warn	557	# overwrite perl's warn
…		…
401	my $msg = join "", @_;	559	my $msg = join "", @_;
402	$msg .= "\n"	560	$msg .= "\n"
403	unless $msg =~ /\n$/;	561	unless $msg =~ /\n$/;
404	urxvt::warn ($msg);	562	urxvt::warn ($msg);
405	};	563	};
		564
		565	# %ENV is the original startup environment
		566	delete $ENV{IFS};
		567	delete $ENV{CDPATH};
		568	delete $ENV{BASH_ENV};
		569	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
406	}	570	}
407		571
408	my @hook_count;	572	my @hook_count;
409	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	573	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
410		574
411	sub verbose {	575	sub verbose {
412	my ($level, $msg) = @_;	576	my ($level, $msg) = @_;
413	warn "$msg\n" if $level <= $verbosity;	577	warn "$msg\n" if $level <= $verbosity;
414	}	578	}
415		579
416	# find on_xxx subs in the package and register them	580	my $extension_pkg = "extension0000";
417	# as hooks	581	my %extension_pkg;
418	sub register_package($) {
419	my ($pkg) = @_;
420
421	for my $htype (0.. $#HOOKNAME) {
422	my $name = $HOOKNAME[$htype];
423
424	my $ref = $pkg->can ("on_" . lc $name)
425	or next;
426
427	$TERM->{_hook}[$htype]{$pkg} = $ref;
428	$hook_count[$htype]++
429	or set_should_invoke $htype, 1;
430	}
431	}
432
433	my $script_pkg = "script0000";
434	my %script_pkg;
435		582
436	# load a single script into its own package, once only	583	# load a single script into its own package, once only
437	sub script_package($) {	584	sub extension_package($) {
438	my ($path) = @_;	585	my ($path) = @_;
439		586
440	$script_pkg{$path} \|\|= do {	587	$extension_pkg{$path} \|\|= do {
441	my $pkg = "urxvt::" . ($script_pkg++);	588	my $pkg = "urxvt::" . ($extension_pkg++);
442		589
443	verbose 3, "loading script '$path' into package '$pkg'";	590	verbose 3, "loading extension '$path' into package '$pkg'";
444		591
445	open my $fh, "<:raw", $path	592	open my $fh, "<:raw", $path
446	or die "$path: $!";	593	or die "$path: $!";
447		594
		595	my $source = untaint
448	my $source = "package $pkg; use strict; use utf8;\n"	596	"package $pkg; use strict; use utf8;\n"
		597	. "use base urxvt::term::extension::;\n"
449	. "#line 1 \"$path\"\n{\n"	598	. "#line 1 \"$path\"\n{\n"
450	. (do { local $/; <$fh> })	599	. (do { local $/; <$fh> })
451	. "\n};\n1";	600	. "\n};\n1";
452		601
		602	eval $source
453	eval $source or die "$path: $@";	603	or die "$path: $@";
454		604
455	$pkg	605	$pkg
456	}	606	}
457	}	607	}
458		608
…		…
463	local $TERM = shift;	613	local $TERM = shift;
464	my $htype = shift;	614	my $htype = shift;
465		615
466	if ($htype == 0) { # INIT	616	if ($htype == 0) { # INIT
467	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	617	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		618
		619	my %ext_arg;
468		620
469	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	621	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		622	if ($_ eq "default") {
		623	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		624	} elsif (/^-(.*)$/) {
		625	delete $ext_arg{$1};
		626	} elsif (/^([^<]+)<(.*)>$/) {
		627	push @{ $ext_arg{$1} }, $2;
		628	} else {
		629	$ext_arg{$_} \|\|= [];
		630	}
		631	}
		632
		633	while (my ($ext, $argv) = each %ext_arg) {
470	my @files = grep -f $_, map "$_/$ext", @dirs;	634	my @files = grep -f $_, map "$_/$ext", @dirs;
471		635
472	if (@files) {	636	if (@files) {
473	register_package script_package $files[0];	637	$TERM->register_package (extension_package $files[0], $argv);
474	} else {	638	} else {
475	warn "perl extension '$ext' not found in perl library search path\n";	639	warn "perl extension '$ext' not found in perl library search path\n";
476	}	640	}
477	}	641	}
		642
		643	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		644	warn $@ if $@;
478	}	645	}
479		646
480	$retval = undef;	647	$retval = undef;
481		648
482	if (my $cb = $TERM->{_hook}[$htype]) {	649	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
484	if $verbosity >= 10;	651	if $verbosity >= 10;
485		652
486	keys %$cb;	653	keys %$cb;
487		654
488	while (my ($pkg, $cb) = each %$cb) {	655	while (my ($pkg, $cb) = each %$cb) {
489	$retval = $cb->(	656	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
490	$TERM->{_pkg}{$pkg} \|\|= do {
491	my $proxy = bless { }, urxvt::term::proxy::;
492	Scalar::Util::weaken ($proxy->{term} = $TERM);
493	$proxy
494	},
495	@_,
496	) and last;	657	and last;
		658
		659	if ($@) {
		660	$TERM->ungrab; # better to lose the grab than the session
		661	warn $@;
		662	}
497	}	663	}
		664
		665	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		666	if $verbosity >= 11;
498	}	667	}
499		668
500	if ($htype == 1) { # DESTROY	669	if ($htype == 1) { # DESTROY
501	# remove hooks if unused
502	if (my $hook = $TERM->{_hook}) {	670	if (my $hook = delete $TERM->{_hook}) {
503	for my $htype (0..$#$hook) {	671	for my $htype (0..$#$hook) {
504	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	672	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
505	or set_should_invoke $htype, 0;	673	or set_should_invoke $htype, 0;
506	}	674	}
507	}	675	}
…		…
514	}	682	}
515		683
516	$retval	684	$retval
517	}	685	}
518		686
519	sub urxvt::term::proxy::AUTOLOAD {	687	sub exec_async(@) {
520	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	688	my $pid = fork;
		689
		690	return
		691	if !defined $pid or $pid;
		692
		693	%ENV = %{ $TERM->env };
		694
		695	exec @_;
		696	_exit 255;
		697	}
		698
		699	# urxvt::term::extension
		700
		701	package urxvt::term::extension;
		702
		703	sub enable {
		704	my ($self, %hook) = @_;
		705	my $pkg = $self->{_pkg};
		706
		707	while (my ($name, $cb) = each %hook) {
		708	my $htype = $HOOKTYPE{uc $name};
		709	defined $htype
		710	or Carp::croak "unsupported hook type '$name'";
		711
		712	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		713	$hook_count[$htype]++
		714	or urxvt::set_should_invoke $htype, 1;
		715	}
		716
		717	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		718	}
		719	}
		720
		721	sub disable {
		722	my ($self, @hook) = @_;
		723	my $pkg = $self->{_pkg};
		724
		725	for my $name (@hook) {
		726	my $htype = $HOOKTYPE{uc $name};
		727	defined $htype
		728	or Carp::croak "unsupported hook type '$name'";
		729
		730	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		731	--$hook_count[$htype]
		732	or urxvt::set_should_invoke $htype, 0;
		733	}
		734	}
		735	}
		736
		737	our $AUTOLOAD;
		738
		739	sub AUTOLOAD {
		740	$AUTOLOAD =~ /:([^:]+)$/
521	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	741	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
522		742
523	eval qq{	743	eval qq{
524	sub $urxvt::term::proxy::AUTOLOAD {	744	sub $AUTOLOAD {
525	my \$proxy = shift;	745	my \$proxy = shift;
526	\$proxy->{term}->$1 (\@_)	746	\$proxy->{term}->$1 (\@_)
527	}	747	}
528	1	748	1
529	} or die "FATAL: unable to compile method forwarder: $@";	749	} or die "FATAL: unable to compile method forwarder: $@";
530		750
531	goto &$urxvt::term::proxy::AUTOLOAD;	751	goto &$AUTOLOAD;
532	}	752	}
		753
		754	sub DESTROY {
		755	# nop
		756	}
		757
		758	# urxvt::destroy_hook
		759
		760	sub urxvt::destroy_hook::DESTROY {
		761	${$_[0]}->();
		762	}
		763
		764	sub urxvt::destroy_hook(&) {
		765	bless \shift, urxvt::destroy_hook::
		766	}
		767
		768	package urxvt::anyevent;
		769
		770	=head2 The C<urxvt::anyevent> Class
		771
		772	The sole purpose of this class is to deliver an interface to the
		773	C<AnyEvent> module - any module using it will work inside urxvt without
		774	further programming. The only exception is that you cannot wait on
		775	condition variables, but non-blocking condvar use is ok. What this means
		776	is that you cannot use blocking APIs, but the non-blocking variant should
		777	work.
		778
		779	=cut
		780
		781	our $VERSION = 1;
		782
		783	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		784	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		785
		786	sub timer {
		787	my ($class, %arg) = @_;
		788
		789	my $cb = $arg{cb};
		790
		791	urxvt::timer
		792	->new
		793	->start (urxvt::NOW + $arg{after})
		794	->cb (sub {
		795	$_[0]->stop; # need to cancel manually
		796	$cb->();
		797	})
		798	}
		799
		800	sub io {
		801	my ($class, %arg) = @_;
		802
		803	my $cb = $arg{cb};
		804
		805	bless [$arg{fh}, urxvt::iow
		806	->new
		807	->fd (fileno $arg{fh})
		808	->events (($arg{poll} =~ /r/ ? 1 : 0)
		809	\| ($arg{poll} =~ /w/ ? 2 : 0))
		810	->start
		811	->cb (sub {
		812	$cb->(($_[1] & 1 ? 'r' : '')
		813	. ($_[1] & 2 ? 'w' : ''));
		814	})],
		815	urxvt::anyevent::
		816	}
		817
		818	sub DESTROY {
		819	$_[0][1]->stop;
		820	}
		821
		822	sub condvar {
		823	bless \my $flag, urxvt::anyevent::condvar::
		824	}
		825
		826	sub urxvt::anyevent::condvar::broadcast {
		827	${$_[0]}++;
		828	}
		829
		830	sub urxvt::anyevent::condvar::wait {
		831	unless (${$_[0]}) {
		832	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		833	}
		834	}
		835
		836	package urxvt::term;
533		837
534	=head2 The C<urxvt::term> Class	838	=head2 The C<urxvt::term> Class
535		839
536	=over 4	840	=over 4
537		841
		842	=cut
		843
		844	# find on_xxx subs in the package and register them
		845	# as hooks
		846	sub register_package {
		847	my ($self, $pkg, $argv) = @_;
		848
		849	my $proxy = bless {
		850	_pkg => $pkg,
		851	argv => $argv,
		852	}, $pkg;
		853	Scalar::Util::weaken ($proxy->{term} = $self);
		854
		855	$self->{_pkg}{$pkg} = $proxy;
		856
		857	for my $name (@HOOKNAME) {
		858	if (my $ref = $pkg->can ("on_" . lc $name)) {
		859	$proxy->enable ($name => $ref);
		860	}
		861	}
		862	}
		863
		864	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		865
		866	Creates a new terminal, very similar as if you had started it with system
		867	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		868	hash which defines the environment of the new terminal.
		869
		870	Croaks (and probably outputs an error message) if the new instance
		871	couldn't be created. Returns C<undef> if the new instance didn't
		872	initialise perl, and the terminal object otherwise. The C<init> and
		873	C<start> hooks will be called during this call.
		874
		875	=cut
		876
		877	sub new {
		878	my ($class, $env, @args) = @_;
		879
		880	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		881	}
		882
538	=item $term->destroy	883	=item $term->destroy
539		884
540	Destroy the terminal object (close the window, free resources etc.).	885	Destroy the terminal object (close the window, free resources
		886	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		887	watchers (timers, io watchers) are still active.
		888
		889	=item $isset = $term->option ($optval[, $set])
		890
		891	Returns true if the option specified by C<$optval> is enabled, and
		892	optionally change it. All option values are stored by name in the hash
		893	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		894
		895	Here is a a likely non-exhaustive list of option names, please see the
		896	source file F</src/optinc.h> to see the actual list:
		897
		898	borderLess console cursorBlink cursorUnderline hold iconic insecure
		899	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		900	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		901	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		902	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		903	tripleclickwords utmpInhibit visualBell
541		904
542	=item $value = $term->resource ($name[, $newval])	905	=item $value = $term->resource ($name[, $newval])
543		906
544	Returns the current resource value associated with a given name and	907	Returns the current resource value associated with a given name and
545	optionally sets a new value. Setting values is most useful in the C<init>	908	optionally sets a new value. Setting values is most useful in the C<init>
…		…
555		918
556	Please note that resource strings will currently only be freed when the	919	Please note that resource strings will currently only be freed when the
557	terminal is destroyed, so changing options frequently will eat memory.	920	terminal is destroyed, so changing options frequently will eat memory.
558		921
559	Here is a a likely non-exhaustive list of resource names, not all of which	922	Here is a a likely non-exhaustive list of resource names, not all of which
560	are supported in every build, please see the source to see the actual	923	are supported in every build, please see the source file F</src/rsinc.h>
561	list:	924	to see the actual list:
562		925
563	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	926	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
564	borderLess color cursorBlink cursorUnderline cutchars delete_key	927	borderLess color cursorBlink cursorUnderline cutchars delete_key
565	display_name embed ext_bwidth fade font geometry hold iconName	928	display_name embed ext_bwidth fade font geometry hold iconName
566	imFont imLocale inputMethod insecure int_bwidth intensityStyles	929	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
573	shade term_name title transparent transparent_all tripleclickwords	936	shade term_name title transparent transparent_all tripleclickwords
574	utmpInhibit visualBell	937	utmpInhibit visualBell
575		938
576	=cut	939	=cut
577		940
578	sub urxvt::term::resource($$;$) {	941	sub resource($$;$) {
579	my ($self, $name) = (shift, shift);	942	my ($self, $name) = (shift, shift);
580	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	943	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
581	goto &urxvt::term::_resource;	944	&urxvt::term::_resource
582	}	945	}
		946
		947	=item $value = $term->x_resource ($pattern)
		948
		949	Returns the X-Resource for the given pattern, excluding the program or
		950	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		951	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		952	resource with that pattern exists.
		953
		954	This method should only be called during the C<on_start> hook, as there is
		955	only one resource database per display, and later invocations might return
		956	the wrong resources.
		957
		958	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		959
		960	Adds a keymap translation exactly as specified via a resource. See the
		961	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
583		962
584	=item $rend = $term->rstyle ([$new_rstyle])	963	=item $rend = $term->rstyle ([$new_rstyle])
585		964
586	Return and optionally change the current rendition. Text that is output by	965	Return and optionally change the current rendition. Text that is output by
587	the terminal application will use this style.	966	the terminal application will use this style.
…		…
598	=item ($row, $col) = $term->selection_end ([$row, $col])	977	=item ($row, $col) = $term->selection_end ([$row, $col])
599		978
600	Return the current values of the selection mark, begin or end positions,	979	Return the current values of the selection mark, begin or end positions,
601	and optionally set them to new values.	980	and optionally set them to new values.
602		981
		982	=item $term->selection_make ($eventtime[, $rectangular])
		983
		984	Tries to make a selection as set by C<selection_beg> and
		985	C<selection_end>. If C<$rectangular> is true (default: false), a
		986	rectangular selection will be made. This is the prefered function to make
		987	a selection.
		988
603	=item $success = $term->selection_grab ($eventtime)	989	=item $success = $term->selection_grab ($eventtime)
604		990
605	Try to request the primary selection from the server (for example, as set	991	Try to request the primary selection text from the server (for example, as
606	by the next method).	992	set by the next method). No visual feedback will be given. This function
		993	is mostly useful from within C<on_sel_grab> hooks.
607		994
608	=item $oldtext = $term->selection ([$newtext])	995	=item $oldtext = $term->selection ([$newtext])
609		996
610	Return the current selection text and optionally replace it by C<$newtext>.	997	Return the current selection text and optionally replace it by C<$newtext>.
611		998
612	#=item $term->overlay ($x, $y, $text)	999	=item $term->overlay_simple ($x, $y, $text)
613	#	1000
614	#Create a simple multi-line overlay box. See the next method for details.	1001	Create a simple multi-line overlay box. See the next method for details.
615	#	1002
616	#=cut	1003	=cut
617	#	1004
618	#sub urxvt::term::scr_overlay {	1005	sub overlay_simple {
619	# my ($self, $x, $y, $text) = @_;	1006	my ($self, $x, $y, $text) = @_;
620	#	1007
621	# my @lines = split /\n/, $text;	1008	my @lines = split /\n/, $text;
622	#	1009
623	# my $w = 0;	1010	my $w = List::Util::max map $self->strwidth ($_), @lines;
624	# for (map $self->strwidth ($_), @lines) {	1011
625	# $w = $_ if $w < $_;
626	# }
627	#
628	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1012	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
629	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1013	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
630	#}	1014
		1015	$overlay
		1016	}
631		1017
632	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1018	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
633		1019
634	Create a new (empty) overlay at the given position with the given	1020	Create a new (empty) overlay at the given position with the given
635	width/height. C<$rstyle> defines the initial rendition style	1021	width/height. C<$rstyle> defines the initial rendition style
…		…
662		1048
663	If hidden, display the overlay again.	1049	If hidden, display the overlay again.
664		1050
665	=back	1051	=back
666		1052
		1053	=item $popup = $term->popup ($event)
		1054
		1055	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1056	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1057	currently).
		1058
		1059	=cut
		1060
		1061	sub popup {
		1062	my ($self, $event) = @_;
		1063
		1064	$self->grab ($event->{time}, 1)
		1065	or return;
		1066
		1067	my $popup = bless {
		1068	term => $self,
		1069	event => $event,
		1070	}, urxvt::popup::;
		1071
		1072	Scalar::Util::weaken $popup->{term};
		1073
		1074	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1075	Scalar::Util::weaken $self->{_destroy}{$popup};
		1076
		1077	$popup
		1078	}
		1079
667	=item $cellwidth = $term->strwidth ($string)	1080	=item $cellwidth = $term->strwidth ($string)
668		1081
669	Returns the number of screen-cells this string would need. Correctly	1082	Returns the number of screen-cells this string would need. Correctly
670	accounts for wide and combining characters.	1083	accounts for wide and combining characters.
671		1084
…		…
674	Convert the given text string into the corresponding locale encoding.	1087	Convert the given text string into the corresponding locale encoding.
675		1088
676	=item $string = $term->locale_decode ($octets)	1089	=item $string = $term->locale_decode ($octets)
677		1090
678	Convert the given locale-encoded octets into a perl string.	1091	Convert the given locale-encoded octets into a perl string.
		1092
		1093	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1094
		1095	XORs the rendition values in the given span with the provided value
		1096	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1097	refresh hooks to provide effects similar to the selection.
		1098
		1099	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1100
		1101	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1102	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1103	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1104	it instead. Both styles I<MUST NOT> contain font styles.
		1105
		1106	=item $term->scr_bell
		1107
		1108	Ring the bell!
679		1109
680	=item $term->scr_add_lines ($string)	1110	=item $term->scr_add_lines ($string)
681		1111
682	Write the given text string to the screen, as if output by the application	1112	Write the given text string to the screen, as if output by the application
683	running inside the terminal. It may not contain command sequences (escape	1113	running inside the terminal. It may not contain command sequences (escape
…		…
698		1128
699	Write the octets given in C<$data> to the tty (i.e. as program input). To	1129	Write the octets given in C<$data> to the tty (i.e. as program input). To
700	pass characters instead of octets, you should convert your strings first	1130	pass characters instead of octets, you should convert your strings first
701	to the locale-specific encoding using C<< $term->locale_encode >>.	1131	to the locale-specific encoding using C<< $term->locale_encode >>.
702		1132
		1133	=item $old_events = $term->pty_ev_events ([$new_events])
		1134
		1135	Replaces the event mask of the pty watcher by the given event mask. Can
		1136	be used to suppress input and output handling to the pty/tty. See the
		1137	description of C<< urxvt::timer->events >>. Make sure to always restore
		1138	the previous value.
		1139
703	=item $windowid = $term->parent	1140	=item $windowid = $term->parent
704		1141
705	Return the window id of the toplevel window.	1142	Return the window id of the toplevel window.
706		1143
707	=item $windowid = $term->vt	1144	=item $windowid = $term->vt
…		…
731	=item $nrow_plus_saveLines = $term->total_rows	1168	=item $nrow_plus_saveLines = $term->total_rows
732		1169
733	=item $lines_in_scrollback = $term->nsaved	1170	=item $lines_in_scrollback = $term->nsaved
734		1171
735	Return various integers describing terminal characteristics.	1172	Return various integers describing terminal characteristics.
		1173
		1174	=item $x_display = $term->display_id
		1175
		1176	Return the DISPLAY used by rxvt-unicode.
		1177
		1178	=item $lc_ctype = $term->locale
		1179
		1180	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1181
		1182	=item $env = $term->env
		1183
		1184	Returns a copy of the environment in effect for the terminal as a hashref
		1185	similar to C<\%ENV>.
		1186
		1187	=cut
		1188
		1189	sub env {
		1190	if (my $env = $_[0]->_env) {
		1191	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1192	} else {
		1193	+{ %ENV }
		1194	}
		1195	}
		1196
		1197	=item $modifiermask = $term->ModLevel3Mask
		1198
		1199	=item $modifiermask = $term->ModMetaMask
		1200
		1201	=item $modifiermask = $term->ModNumLockMask
		1202
		1203	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1204	AltGr), the meta key (often Alt) and the num lock key, if applicable.
736		1205
737	=item $view_start = $term->view_start ([$newvalue])	1206	=item $view_start = $term->view_start ([$newvalue])
738		1207
739	Returns the negative row number of the topmost line. Minimum value is	1208	Returns the negative row number of the topmost line. Minimum value is
740	C<0>, which displays the normal terminal contents. Larger values scroll	1209	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
824	Return the row number of the first/last row of the line, respectively.	1293	Return the row number of the first/last row of the line, respectively.
825		1294
826	=item $offset = $line->offset_of ($row, $col)	1295	=item $offset = $line->offset_of ($row, $col)
827		1296
828	Returns the character offset of the given row\|col pair within the logical	1297	Returns the character offset of the given row\|col pair within the logical
829	line.	1298	line. Works for rows outside the line, too, and returns corresponding
		1299	offsets outside the string.
830		1300
831	=item ($row, $col) = $line->coord_of ($offset)	1301	=item ($row, $col) = $line->coord_of ($offset)
832		1302
833	Translates a string offset into terminal coordinates again.	1303	Translates a string offset into terminal coordinates again.
834		1304
835	=back	1305	=back
836		1306
837	=cut	1307	=cut
838		1308
839	sub urxvt::term::line {	1309	sub line {
840	my ($self, $row) = @_;	1310	my ($self, $row) = @_;
841		1311
842	my $maxrow = $self->nrow - 1;	1312	my $maxrow = $self->nrow - 1;
843		1313
844	my ($beg, $end) = ($row, $row);	1314	my ($beg, $end) = ($row, $row);
…		…
908	$offset / $self->{ncol} + $self->{beg},	1378	$offset / $self->{ncol} + $self->{beg},
909	$offset % $self->{ncol}	1379	$offset % $self->{ncol}
910	)	1380	)
911	}	1381	}
912		1382
913	=item ($row, $col) = $line->coord_of ($offset)
914	=item $text = $term->special_encode $string	1383	=item $text = $term->special_encode $string
915		1384
916	Converts a perl string into the special encoding used by rxvt-unicode,	1385	Converts a perl string into the special encoding used by rxvt-unicode,
917	where one character corresponds to one screen cell. See	1386	where one character corresponds to one screen cell. See
918	C<< $term->ROW_t >> for details.	1387	C<< $term->ROW_t >> for details.
919		1388
920	=item $string = $term->special_decode $text	1389	=item $string = $term->special_decode $text
921		1390
922	Converts rxvt-unicodes text reprsentation into a perl string. See	1391	Converts rxvt-unicodes text reprsentation into a perl string. See
923	C<< $term->ROW_t >> for details.	1392	C<< $term->ROW_t >> for details.
		1393
		1394	=item $success = $term->grab_button ($button, $modifiermask)
		1395
		1396	Registers a synchronous button grab. See the XGrabButton manpage.
		1397
		1398	=item $success = $term->grab ($eventtime[, $sync])
		1399
		1400	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1401	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1402
		1403	=item $term->allow_events_async
		1404
		1405	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1406
		1407	=item $term->allow_events_sync
		1408
		1409	Calls XAllowEvents with SyncBoth for the most recent grab.
		1410
		1411	=item $term->allow_events_replay
		1412
		1413	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1414	recent grab.
		1415
		1416	=item $term->ungrab
		1417
		1418	Calls XUngrab for the most recent grab. Is called automatically on
		1419	evaluation errors, as it is better to lose the grab in the error case as
		1420	the session.
		1421
		1422	=back
		1423
		1424	=cut
		1425
		1426	package urxvt::popup;
		1427
		1428	=head2 The C<urxvt::popup> Class
		1429
		1430	=over 4
		1431
		1432	=cut
		1433
		1434	sub add_item {
		1435	my ($self, $item) = @_;
		1436
		1437	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1438	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1439	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1440
		1441	$item->{render} \|\|= sub { $_[0]{text} };
		1442
		1443	push @{ $self->{item} }, $item;
		1444	}
		1445
		1446	=item $popup->add_title ($title)
		1447
		1448	Adds a non-clickable title to the popup.
		1449
		1450	=cut
		1451
		1452	sub add_title {
		1453	my ($self, $title) = @_;
		1454
		1455	$self->add_item ({
		1456	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1457	text => $title,
		1458	activate => sub { },
		1459	});
		1460	}
		1461
		1462	=item $popup->add_separator ([$sepchr])
		1463
		1464	Creates a separator, optionally using the character given as C<$sepchr>.
		1465
		1466	=cut
		1467
		1468	sub add_separator {
		1469	my ($self, $sep) = @_;
		1470
		1471	$sep \|\|= "=";
		1472
		1473	$self->add_item ({
		1474	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1475	text => "",
		1476	render => sub { $sep x $self->{term}->ncol },
		1477	activate => sub { },
		1478	});
		1479	}
		1480
		1481	=item $popup->add_button ($text, $cb)
		1482
		1483	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1484	selected.
		1485
		1486	=cut
		1487
		1488	sub add_button {
		1489	my ($self, $text, $cb) = @_;
		1490
		1491	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1492	}
		1493
		1494	=item $popup->add_toggle ($text, $cb, $initial_value)
		1495
		1496	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1497	whenever it gets toggled, with a boolean indicating its value as its first
		1498	argument.
		1499
		1500	=cut
		1501
		1502	sub add_toggle {
		1503	my ($self, $text, $cb, $value) = @_;
		1504
		1505	my $item; $item = {
		1506	type => "button",
		1507	text => " $text",
		1508	value => $value,
		1509	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1510	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1511	};
		1512
		1513	$self->add_item ($item);
		1514	}
		1515
		1516	=item $popup->show
		1517
		1518	Displays the popup (which is initially hidden).
		1519
		1520	=cut
		1521
		1522	sub show {
		1523	my ($self) = @_;
		1524
		1525	local $urxvt::popup::self = $self;
		1526
		1527	my $env = $self->{term}->env;
		1528	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1529	delete $env->{LC_ALL};
		1530	$env->{LC_CTYPE} = $self->{term}->locale;
		1531
		1532	urxvt::term->new ($env, $self->{term}->resource ("name"),
		1533	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1534	"--transient-for" => $self->{term}->parent,
		1535	"-display" => $self->{term}->display_id,
		1536	"-pe" => "urxvt-popup")
		1537	or die "unable to create popup window\n";
		1538	}
		1539
		1540	sub DESTROY {
		1541	my ($self) = @_;
		1542
		1543	delete $self->{term}{_destroy}{$self};
		1544	$self->{term}->ungrab;
		1545	}
924		1546
925	=back	1547	=back
926		1548
927	=head2 The C<urxvt::timer> Class	1549	=head2 The C<urxvt::timer> Class
928		1550
…		…
983		1605
984	$term->{socket} = ...	1606	$term->{socket} = ...
985	$term->{iow} = urxvt::iow	1607	$term->{iow} = urxvt::iow
986	->new	1608	->new
987	->fd (fileno $term->{socket})	1609	->fd (fileno $term->{socket})
988	->events (1) # wait for read data	1610	->events (urxvt::EVENT_READ)
989	->start	1611	->start
990	->cb (sub {	1612	->cb (sub {
991	my ($iow, $revents) = @_;	1613	my ($iow, $revents) = @_;
992	# $revents must be 1 here, no need to check	1614	# $revents must be 1 here, no need to check
993	sysread $term->{socket}, my $buf, 8192	1615	sysread $term->{socket}, my $buf, 8192
…		…
1010		1632
1011	Set the filedescriptor (not handle) to watch.	1633	Set the filedescriptor (not handle) to watch.
1012		1634
1013	=item $iow = $iow->events ($eventmask)	1635	=item $iow = $iow->events ($eventmask)
1014		1636
1015	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1637	Set the event mask to watch. The only allowed values are
1016	data, Bit #1 (value C<2>) enables watching for write data.	1638	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1639	together, or C<urxvt::EVENT_NONE>.
1017		1640
1018	=item $iow = $iow->start	1641	=item $iow = $iow->start
1019		1642
1020	Start watching for requested events on the given handle.	1643	Start watching for requested events on the given handle.
1021		1644
…		…
1032	This variable controls the verbosity level of the perl extension. Higher	1655	This variable controls the verbosity level of the perl extension. Higher
1033	numbers indicate more verbose output.	1656	numbers indicate more verbose output.
1034		1657
1035	=over 4	1658	=over 4
1036		1659
1037	=item =0 - only fatal messages	1660	=item == 0 - fatal messages
1038		1661
1039	=item =3 - script loading and management	1662	=item >= 3 - script loading and management
1040		1663
1041	=item =10 - all events received	1664	=item >=10 - all called hooks
		1665
		1666	=item >=11 - hook reutrn values
1042		1667
1043	=back	1668	=back
1044		1669
1045	=head1 AUTHOR	1670	=head1 AUTHOR
1046		1671

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.42 by root, Fri Jan 6 21:06:09 2006 UTC vs. Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.42 by root, Fri Jan 6 21:06:09 2006 UTC vs.
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC