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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.53 by root, Sun Jan 8 01:16:09 2006 UTC vs.
Revision 1.94 by root, Sun Jan 15 06:02:41 2006 UTC

…		…
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/^([^:[:space:]]+):(\\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/^([^:[:space:]]+(\\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 extension files, 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. It is, however, blessed intot he package of the extension script,
129	so for all practical purposes you can treat an extension script as a class.
130		247
131	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
132	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
133	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.
134		251
135	When in doubt, return a false value (preferably C<()>).	252	I<< When in doubt, return a false value (preferably C<()>). >>
136		253
137	=over 4	254	=over 4
138		255
139	=item on_init $term	256	=item on_init $term
140		257
…		…
175	=item on_sel_extend $term	292	=item on_sel_extend $term
176		293
177	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
178	click) and is either supposed to return false (normal operation), or	295	click) and is either supposed to return false (normal operation), or
179	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
180	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.
181		300
182	See the F<selection> example extension.	301	See the F<selection> example extension.
183		302
184	=item on_view_change $term, $offset	303	=item on_view_change $term, $offset
185		304
…		…
194	than the scroll back buffer or the terminal.	313	than the scroll back buffer or the terminal.
195		314
196	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,
197	$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
198	number of lines that will be in the scrollback buffer.	317	number of lines that will be in the scrollback buffer.
199
200	=item on_tty_activity $term NYI
201
202	Called whenever the program(s) running in the urxvt window send output.
203		318
204	=item on_osc_seq $term, $string	319	=item on_osc_seq $term, $string
205		320
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	321	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	322	operating system command) is processed. Cursor position and other state
…		…
220	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
221	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
222	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
223	output.	338	output.
224		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
225	=item on_line_update $term, $row	345	=item on_line_update $term, $row
226		346
227	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
228	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
229	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,
…		…
251		371
252	Called whenever the user presses a key combination that has a	372	Called whenever the user presses a key combination that has a
253	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>
254	resource in the @@RXVT_NAME@@(1) manpage).	374	resource in the @@RXVT_NAME@@(1) manpage).
255		375
		376	=item on_x_event $term, $event
		377
		378	Called on every X event received on the vt window (and possibly other
		379	windows). Should only be used as a last resort. Most event structure
		380	members are not passed.
		381
256	=item on_focus_in $term	382	=item on_focus_in $term
257		383
258	Called whenever the window gets the keyboard focus, before rxvt-unicode	384	Called whenever the window gets the keyboard focus, before rxvt-unicode
259	does focus in processing.	385	does focus in processing.
260		386
261	=item on_focus_out $term	387	=item on_focus_out $term
262		388
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	389	Called wheneever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	390	focus out processing.
265		391
266	=item on_key_press $term, $event, $octets	392	=item on_key_press $term, $event, $keysym, $octets
267		393
268	=item on_key_release $term, $event	394	=item on_key_release $term, $event, $keysym
269		395
270	=item on_button_press $term, $event	396	=item on_button_press $term, $event
271		397
272	=item on_button_release $term, $event	398	=item on_button_release $term, $event
273		399
…		…
289		415
290	subwindow.	416	subwindow.
291		417
292	=back	418	=back
293		419
		420	=cut
		421
		422	package urxvt;
		423
		424	use utf8;
		425	use strict;
		426	use Carp ();
		427	use Scalar::Util ();
		428	use List::Util ();
		429
		430	our $VERSION = 1;
		431	our $TERM;
		432	our @HOOKNAME;
		433	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		434	our %OPTION;
		435
		436	our $LIBDIR;
		437	our $RESNAME;
		438	our $RESCLASS;
		439	our $RXVTNAME;
		440
294	=head2 Variables in the C<urxvt> Package	441	=head2 Variables in the C<urxvt> Package
295		442
296	=over 4	443	=over 4
		444
		445	=item $urxvt::LIBDIR
		446
		447	The rxvt-unicode library directory, where, among other things, the perl
		448	modules and scripts are stored.
		449
		450	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		451
		452	The resource class and name rxvt-unicode uses to look up X resources.
		453
		454	=item $urxvt::RXVTNAME
		455
		456	The basename of the installed binaries, usually C<urxvt>.
297		457
298	=item $urxvt::TERM	458	=item $urxvt::TERM
299		459
300	The current terminal. This variable stores the current C<urxvt::term>	460	The current terminal. This variable stores the current C<urxvt::term>
301	object, whenever a callback/hook is executing.	461	object, whenever a callback/hook is executing.
…		…
303	=back	463	=back
304		464
305	=head2 Functions in the C<urxvt> Package	465	=head2 Functions in the C<urxvt> Package
306		466
307	=over 4	467	=over 4
308
309	=item $term = new urxvt [arg...]
310
311	Creates a new terminal, very similar as if you had started it with
312	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
313	if the new instance couldn't be created. Returns C<undef> if the new
314	instance didn't initialise perl, and the terminal object otherwise. The
315	C<init> and C<start> hooks will be called during the call.
316		468
317	=item urxvt::fatal $errormessage	469	=item urxvt::fatal $errormessage
318		470
319	Fatally aborts execution with the given error message. Avoid at all	471	Fatally aborts execution with the given error message. Avoid at all
320	costs! The only time this is acceptable is when the terminal process	472	costs! The only time this is acceptable is when the terminal process
…		…
327	that calls this function.	479	that calls this function.
328		480
329	Using this function has the advantage that its output ends up in the	481	Using this function has the advantage that its output ends up in the
330	correct place, e.g. on stderr of the connecting urxvtc client.	482	correct place, e.g. on stderr of the connecting urxvtc client.
331		483
		484	Messages have a size limit of 1023 bytes currently.
		485
		486	=item $is_safe = urxvt::safe
		487
		488	Returns true when it is safe to do potentially unsafe things, such as
		489	evaluating perl code specified by the user. This is true when urxvt was
		490	started setuid or setgid.
		491
332	=item $time = urxvt::NOW	492	=item $time = urxvt::NOW
333		493
334	Returns the "current time" (as per the event loop).	494	Returns the "current time" (as per the event loop).
335		495
336	=item urxvt::CurrentTime	496	=item urxvt::CurrentTime
337		497
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	498	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	499	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	500	Button4Mask, Button5Mask, AnyModifier
341		501
		502	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		503	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		504	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		505	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		506	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		507	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		508	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		509
		510	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		511	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		512	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		513	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		514	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		515	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		516	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		517
342	Various constants for use in X events.	518	Various constants for use in X calls and event processing.
343		519
344	=back	520	=back
345		521
346	=head2 RENDITION	522	=head2 RENDITION
347		523
…		…
374		550
375	=item $background = urxvt::GET_BASEBG $rend	551	=item $background = urxvt::GET_BASEBG $rend
376		552
377	Return the foreground/background colour index, respectively.	553	Return the foreground/background colour index, respectively.
378		554
379	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	555	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
380		556
381	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	557	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
382		558
383	Replace the foreground/background colour in the rendition mask with the	559	Replace the foreground/background colour in the rendition mask with the
384	specified one.	560	specified one.
385		561
386	=item $value = urxvt::GET_CUSTOM ($rend)	562	=item $value = urxvt::GET_CUSTOM $rend
387		563
388	Return the "custom" value: Every rendition has 5 bits for use by	564	Return the "custom" value: Every rendition has 5 bits for use by
389	extensions. They can be set and changed as you like and are initially	565	extensions. They can be set and changed as you like and are initially
390	zero.	566	zero.
391		567
392	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	568	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
393		569
394	Change the custom value.	570	Change the custom value.
395		571
396	=back	572	=back
397		573
398	=cut	574	=cut
399
400	package urxvt;
401
402	use utf8;
403	use strict;
404	use Scalar::Util ();
405	use List::Util ();
406
407	our $TERM;
408	our @HOOKNAME;
409	our %OPTION;
410	our $LIBDIR;
411		575
412	BEGIN {	576	BEGIN {
413	urxvt->bootstrap;	577	urxvt->bootstrap;
414		578
415	# overwrite perl's warn	579	# overwrite perl's warn
…		…
417	my $msg = join "", @_;	581	my $msg = join "", @_;
418	$msg .= "\n"	582	$msg .= "\n"
419	unless $msg =~ /\n$/;	583	unless $msg =~ /\n$/;
420	urxvt::warn ($msg);	584	urxvt::warn ($msg);
421	};	585	};
422	}
423		586
424	my @hook_count;	587	# %ENV is the original startup environment
		588	delete $ENV{IFS};
		589	delete $ENV{CDPATH};
		590	delete $ENV{BASH_ENV};
		591	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
		592	}
		593
425	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	594	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
426		595
427	sub verbose {	596	sub verbose {
428	my ($level, $msg) = @_;	597	my ($level, $msg) = @_;
429	warn "$msg\n" if $level <= $verbosity;	598	warn "$msg\n" if $level <= $verbosity;
430	}	599	}
431		600
432	# find on_xxx subs in the package and register them
433	# as hooks
434	sub register_package($) {
435	my ($pkg) = @_;
436
437	for my $htype (0.. $#HOOKNAME) {
438	my $name = $HOOKNAME[$htype];
439
440	my $ref = $pkg->can ("on_" . lc $name)
441	or next;
442
443	$TERM->{_hook}[$htype]{$pkg} = $ref;
444	$hook_count[$htype]++
445	or set_should_invoke $htype, 1;
446	}
447	}
448
449	my $extension_pkg = "extension0000";	601	my $extension_pkg = "extension0000";
450	my %extension_pkg;	602	my %extension_pkg;
451		603
452	# load a single script into its own package, once only	604	# load a single script into its own package, once only
453	sub extension_package($) {	605	sub extension_package($) {
…		…
459	verbose 3, "loading extension '$path' into package '$pkg'";	611	verbose 3, "loading extension '$path' into package '$pkg'";
460		612
461	open my $fh, "<:raw", $path	613	open my $fh, "<:raw", $path
462	or die "$path: $!";	614	or die "$path: $!";
463		615
		616	my $source = untaint
464	my $source = "package $pkg; use strict; use utf8;\n"	617	"package $pkg; use strict; use utf8;\n"
465	. "use base urxvt::term::proxy::;\n"	618	. "use base urxvt::term::extension::;\n"
466	. "#line 1 \"$path\"\n{\n"	619	. "#line 1 \"$path\"\n{\n"
467	. (do { local $/; <$fh> })	620	. (do { local $/; <$fh> })
468	. "\n};\n1";	621	. "\n};\n1";
469		622
		623	eval $source
470	eval $source or die "$path: $@";	624	or die "$path: $@";
471		625
472	$pkg	626	$pkg
473	}	627	}
474	}	628	}
475		629
…		…
481	my $htype = shift;	635	my $htype = shift;
482		636
483	if ($htype == 0) { # INIT	637	if ($htype == 0) { # INIT
484	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	638	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
485		639
486	my %want_ext;	640	my %ext_arg;
487		641
488	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	642	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
489	if ($_ eq "default") {	643	if ($_ eq "default") {
490	$want_ext{$_}++ for qw(selection option-popup);	644	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
491	} elsif (/^-(.*)$/) {	645	} elsif (/^-(.*)$/) {
492	delete $want_ext{$1};	646	delete $ext_arg{$1};
		647	} elsif (/^([^<]+)<(.*)>$/) {
		648	push @{ $ext_arg{$1} }, $2;
493	} else {	649	} else {
494	$want_ext{$_}++;	650	$ext_arg{$_} \|\|= [];
495	}	651	}
496	}	652	}
497		653
498	for my $ext (keys %want_ext) {	654	while (my ($ext, $argv) = each %ext_arg) {
499	my @files = grep -f $_, map "$_/$ext", @dirs;	655	my @files = grep -f $_, map "$_/$ext", @dirs;
500		656
501	if (@files) {	657	if (@files) {
502	register_package extension_package $files[0];	658	$TERM->register_package (extension_package $files[0], $argv);
503	} else {	659	} else {
504	warn "perl extension '$ext' not found in perl library search path\n";	660	warn "perl extension '$ext' not found in perl library search path\n";
505	}	661	}
506	}	662	}
		663
		664	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		665	warn $@ if $@;
507	}	666	}
508		667
509	$retval = undef;	668	$retval = undef;
510		669
511	if (my $cb = $TERM->{_hook}[$htype]) {	670	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
513	if $verbosity >= 10;	672	if $verbosity >= 10;
514		673
515	keys %$cb;	674	keys %$cb;
516		675
517	while (my ($pkg, $cb) = each %$cb) {	676	while (my ($pkg, $cb) = each %$cb) {
518	eval {	677	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
519	$retval = $cb->(
520	$TERM->{_pkg}{$pkg} \|\|= do {
521	my $proxy = bless { }, $pkg;
522	Scalar::Util::weaken ($proxy->{term} = $TERM);
523	$proxy
524	},
525	@_,
526	) and last;	678	and last;
527	};
528	warn $@ if $@;#d#
529	}
530	}
531		679
532	if ($htype == 1) { # DESTROY	680	if ($@) {
533	# remove hooks if unused	681	$TERM->ungrab; # better to lose the grab than the session
534	if (my $hook = $TERM->{_hook}) {	682	warn $@;
535	for my $htype (0..$#$hook) {
536	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
537	or set_should_invoke $htype, 0;
538	}	683	}
539	}	684	}
540		685
		686	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		687	if $verbosity >= 11;
		688	}
		689
		690	if ($htype == 1) { # DESTROY
541	# clear package objects	691	# clear package objects
542	%$_ = () for values %{ $TERM->{_pkg} };	692	%$_ = () for values %{ $TERM->{_pkg} };
543		693
544	# clear package	694	# clear package
545	%$TERM = ();	695	%$TERM = ();
546	}	696	}
547		697
548	$retval	698	$retval
549	}	699	}
550		700
551	sub urxvt::term::proxy::AUTOLOAD {	701	sub exec_async(@) {
552	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	702	my $pid = fork;
		703
		704	return
		705	if !defined $pid or $pid;
		706
		707	%ENV = %{ $TERM->env };
		708
		709	exec @_;
		710	_exit 255;
		711	}
		712
		713	# urxvt::term::extension
		714
		715	package urxvt::term::extension;
		716
		717	sub enable {
		718	my ($self, %hook) = @_;
		719	my $pkg = $self->{_pkg};
		720
		721	while (my ($name, $cb) = each %hook) {
		722	my $htype = $HOOKTYPE{uc $name};
		723	defined $htype
		724	or Carp::croak "unsupported hook type '$name'";
		725
		726	$self->set_should_invoke ($htype, +1)
		727	unless exists $self->{term}{_hook}[$htype]{$pkg};
		728
		729	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		730	}
		731	}
		732
		733	sub disable {
		734	my ($self, @hook) = @_;
		735	my $pkg = $self->{_pkg};
		736
		737	for my $name (@hook) {
		738	my $htype = $HOOKTYPE{uc $name};
		739	defined $htype
		740	or Carp::croak "unsupported hook type '$name'";
		741
		742	$self->set_should_invoke ($htype, -1)
		743	if delete $self->{term}{_hook}[$htype]{$pkg};
		744	}
		745	}
		746
		747	our $AUTOLOAD;
		748
		749	sub AUTOLOAD {
		750	$AUTOLOAD =~ /:([^:]+)$/
553	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	751	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
554		752
555	eval qq{	753	eval qq{
556	sub $urxvt::term::proxy::AUTOLOAD {	754	sub $AUTOLOAD {
557	my \$proxy = shift;	755	my \$proxy = shift;
558	\$proxy->{term}->$1 (\@_)	756	\$proxy->{term}->$1 (\@_)
559	}	757	}
560	1	758	1
561	} or die "FATAL: unable to compile method forwarder: $@";	759	} or die "FATAL: unable to compile method forwarder: $@";
562		760
563	goto &$urxvt::term::proxy::AUTOLOAD;	761	goto &$AUTOLOAD;
564	}	762	}
		763
		764	sub DESTROY {
		765	# nop
		766	}
		767
		768	# urxvt::destroy_hook
565		769
566	sub urxvt::destroy_hook::DESTROY {	770	sub urxvt::destroy_hook::DESTROY {
567	${$_[0]}->();	771	${$_[0]}->();
568	}	772	}
569		773
570	sub urxvt::destroy_hook(&) {	774	sub urxvt::destroy_hook(&) {
571	bless \shift, urxvt::destroy_hook::	775	bless \shift, urxvt::destroy_hook::
572	}	776	}
573		777
		778	package urxvt::anyevent;
		779
		780	=head2 The C<urxvt::anyevent> Class
		781
		782	The sole purpose of this class is to deliver an interface to the
		783	C<AnyEvent> module - any module using it will work inside urxvt without
		784	further programming. The only exception is that you cannot wait on
		785	condition variables, but non-blocking condvar use is ok. What this means
		786	is that you cannot use blocking APIs, but the non-blocking variant should
		787	work.
		788
		789	=cut
		790
		791	our $VERSION = 1;
		792
		793	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		794	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		795
		796	sub timer {
		797	my ($class, %arg) = @_;
		798
		799	my $cb = $arg{cb};
		800
		801	urxvt::timer
		802	->new
		803	->start (urxvt::NOW + $arg{after})
		804	->cb (sub {
		805	$_[0]->stop; # need to cancel manually
		806	$cb->();
		807	})
		808	}
		809
		810	sub io {
		811	my ($class, %arg) = @_;
		812
		813	my $cb = $arg{cb};
		814
		815	bless [$arg{fh}, urxvt::iow
		816	->new
		817	->fd (fileno $arg{fh})
		818	->events (($arg{poll} =~ /r/ ? 1 : 0)
		819	\| ($arg{poll} =~ /w/ ? 2 : 0))
		820	->start
		821	->cb (sub {
		822	$cb->(($_[1] & 1 ? 'r' : '')
		823	. ($_[1] & 2 ? 'w' : ''));
		824	})],
		825	urxvt::anyevent::
		826	}
		827
		828	sub DESTROY {
		829	$_[0][1]->stop;
		830	}
		831
		832	sub condvar {
		833	bless \my $flag, urxvt::anyevent::condvar::
		834	}
		835
		836	sub urxvt::anyevent::condvar::broadcast {
		837	${$_[0]}++;
		838	}
		839
		840	sub urxvt::anyevent::condvar::wait {
		841	unless (${$_[0]}) {
		842	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		843	}
		844	}
		845
		846	package urxvt::term;
		847
574	=head2 The C<urxvt::term> Class	848	=head2 The C<urxvt::term> Class
575		849
576	=over 4	850	=over 4
577		851
		852	=cut
		853
		854	# find on_xxx subs in the package and register them
		855	# as hooks
		856	sub register_package {
		857	my ($self, $pkg, $argv) = @_;
		858
		859	my $proxy = bless {
		860	_pkg => $pkg,
		861	argv => $argv,
		862	}, $pkg;
		863	Scalar::Util::weaken ($proxy->{term} = $self);
		864
		865	$self->{_pkg}{$pkg} = $proxy;
		866
		867	for my $name (@HOOKNAME) {
		868	if (my $ref = $pkg->can ("on_" . lc $name)) {
		869	$proxy->enable ($name => $ref);
		870	}
		871	}
		872	}
		873
		874	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		875
		876	Creates a new terminal, very similar as if you had started it with system
		877	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		878	hash which defines the environment of the new terminal.
		879
		880	Croaks (and probably outputs an error message) if the new instance
		881	couldn't be created. Returns C<undef> if the new instance didn't
		882	initialise perl, and the terminal object otherwise. The C<init> and
		883	C<start> hooks will be called during this call.
		884
		885	=cut
		886
		887	sub new {
		888	my ($class, $env, @args) = @_;
		889
		890	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		891	}
		892
578	=item $term->destroy	893	=item $term->destroy
579		894
580	Destroy the terminal object (close the window, free resources etc.).	895	Destroy the terminal object (close the window, free resources
		896	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		897	watchers (timers, io watchers) are still active.
581		898
582	=item $isset = $term->option ($optval[, $set])	899	=item $isset = $term->option ($optval[, $set])
583		900
584	Returns true if the option specified by C<$optval> is enabled, and	901	Returns true if the option specified by C<$optval> is enabled, and
585	optionally change it. All option values are stored by name in the hash	902	optionally change it. All option values are stored by name in the hash
…		…
629	shade term_name title transparent transparent_all tripleclickwords	946	shade term_name title transparent transparent_all tripleclickwords
630	utmpInhibit visualBell	947	utmpInhibit visualBell
631		948
632	=cut	949	=cut
633		950
634	sub urxvt::term::resource($$;$) {	951	sub resource($$;$) {
635	my ($self, $name) = (shift, shift);	952	my ($self, $name) = (shift, shift);
636	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	953	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
637	&urxvt::term::_resource	954	&urxvt::term::_resource
638	}	955	}
639		956
		957	=item $value = $term->x_resource ($pattern)
		958
		959	Returns the X-Resource for the given pattern, excluding the program or
		960	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		961	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		962	resource with that pattern exists.
		963
		964	This method should only be called during the C<on_start> hook, as there is
		965	only one resource database per display, and later invocations might return
		966	the wrong resources.
		967
		968	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		969
		970	Adds a keymap translation exactly as specified via a resource. See the
		971	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		972
640	=item $rend = $term->rstyle ([$new_rstyle])	973	=item $rend = $term->rstyle ([$new_rstyle])
641		974
642	Return and optionally change the current rendition. Text that is output by	975	Return and optionally change the current rendition. Text that is output by
643	the terminal application will use this style.	976	the terminal application will use this style.
644		977
…		…
654	=item ($row, $col) = $term->selection_end ([$row, $col])	987	=item ($row, $col) = $term->selection_end ([$row, $col])
655		988
656	Return the current values of the selection mark, begin or end positions,	989	Return the current values of the selection mark, begin or end positions,
657	and optionally set them to new values.	990	and optionally set them to new values.
658		991
		992	=item $term->selection_make ($eventtime[, $rectangular])
		993
		994	Tries to make a selection as set by C<selection_beg> and
		995	C<selection_end>. If C<$rectangular> is true (default: false), a
		996	rectangular selection will be made. This is the prefered function to make
		997	a selection.
		998
659	=item $success = $term->selection_grab ($eventtime)	999	=item $success = $term->selection_grab ($eventtime)
660		1000
661	Try to request the primary selection from the server (for example, as set	1001	Try to request the primary selection text from the server (for example, as
662	by the next method).	1002	set by the next method). No visual feedback will be given. This function
		1003	is mostly useful from within C<on_sel_grab> hooks.
663		1004
664	=item $oldtext = $term->selection ([$newtext])	1005	=item $oldtext = $term->selection ([$newtext])
665		1006
666	Return the current selection text and optionally replace it by C<$newtext>.	1007	Return the current selection text and optionally replace it by C<$newtext>.
667		1008
668	#=item $term->overlay ($x, $y, $text)	1009	=item $term->overlay_simple ($x, $y, $text)
669	#	1010
670	#Create a simple multi-line overlay box. See the next method for details.	1011	Create a simple multi-line overlay box. See the next method for details.
671	#	1012
672	#=cut	1013	=cut
673	#	1014
674	#sub urxvt::term::scr_overlay {	1015	sub overlay_simple {
675	# my ($self, $x, $y, $text) = @_;	1016	my ($self, $x, $y, $text) = @_;
676	#	1017
677	# my @lines = split /\n/, $text;	1018	my @lines = split /\n/, $text;
678	#	1019
679	# my $w = 0;	1020	my $w = List::Util::max map $self->strwidth ($_), @lines;
680	# for (map $self->strwidth ($_), @lines) {	1021
681	# $w = $_ if $w < $_;
682	# }
683	#
684	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1022	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
685	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1023	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
686	#}	1024
		1025	$overlay
		1026	}
687		1027
688	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1028	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
689		1029
690	Create a new (empty) overlay at the given position with the given	1030	Create a new (empty) overlay at the given position with the given
691	width/height. C<$rstyle> defines the initial rendition style	1031	width/height. C<$rstyle> defines the initial rendition style
…		…
726	C<$event> I<must> be the event causing the menu to pop up (a button event,	1066	C<$event> I<must> be the event causing the menu to pop up (a button event,
727	currently).	1067	currently).
728		1068
729	=cut	1069	=cut
730		1070
731	sub urxvt::term::popup {	1071	sub popup {
732	my ($self, $event) = @_;	1072	my ($self, $event) = @_;
733		1073
734	$self->grab ($event->{time}, 1)	1074	$self->grab ($event->{time}, 1)
735	or return;	1075	or return;
736		1076
…		…
758		1098
759	=item $string = $term->locale_decode ($octets)	1099	=item $string = $term->locale_decode ($octets)
760		1100
761	Convert the given locale-encoded octets into a perl string.	1101	Convert the given locale-encoded octets into a perl string.
762		1102
		1103	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1104
		1105	XORs the rendition values in the given span with the provided value
		1106	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1107	refresh hooks to provide effects similar to the selection.
		1108
		1109	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1110
		1111	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1112	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1113	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1114	it instead. Both styles I<MUST NOT> contain font styles.
		1115
		1116	=item $term->scr_bell
		1117
		1118	Ring the bell!
		1119
763	=item $term->scr_add_lines ($string)	1120	=item $term->scr_add_lines ($string)
764		1121
765	Write the given text string to the screen, as if output by the application	1122	Write the given text string to the screen, as if output by the application
766	running inside the terminal. It may not contain command sequences (escape	1123	running inside the terminal. It may not contain command sequences (escape
767	codes), but is free to use line feeds, carriage returns and tabs. The	1124	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
781		1138
782	Write the octets given in C<$data> to the tty (i.e. as program input). To	1139	Write the octets given in C<$data> to the tty (i.e. as program input). To
783	pass characters instead of octets, you should convert your strings first	1140	pass characters instead of octets, you should convert your strings first
784	to the locale-specific encoding using C<< $term->locale_encode >>.	1141	to the locale-specific encoding using C<< $term->locale_encode >>.
785		1142
		1143	=item $old_events = $term->pty_ev_events ([$new_events])
		1144
		1145	Replaces the event mask of the pty watcher by the given event mask. Can
		1146	be used to suppress input and output handling to the pty/tty. See the
		1147	description of C<< urxvt::timer->events >>. Make sure to always restore
		1148	the previous value.
		1149
786	=item $windowid = $term->parent	1150	=item $windowid = $term->parent
787		1151
788	Return the window id of the toplevel window.	1152	Return the window id of the toplevel window.
789		1153
790	=item $windowid = $term->vt	1154	=item $windowid = $term->vt
791		1155
792	Return the window id of the terminal window.	1156	Return the window id of the terminal window.
793		1157
		1158	=item $term->vt_emask_add ($x_event_mask)
		1159
		1160	Adds the specified events to the vt event mask. Useful e.g. when you want
		1161	to receive pointer events all the times:
		1162
		1163	$term->vt_emask_add (urxvt::PointerMotionMask);
		1164
794	=item $window_width = $term->width	1165	=item $window_width = $term->width
795		1166
796	=item $window_height = $term->height	1167	=item $window_height = $term->height
797		1168
798	=item $font_width = $term->fwidth	1169	=item $font_width = $term->fwidth
…		…
811		1182
812	=item $max_scrollback = $term->saveLines	1183	=item $max_scrollback = $term->saveLines
813		1184
814	=item $nrow_plus_saveLines = $term->total_rows	1185	=item $nrow_plus_saveLines = $term->total_rows
815		1186
816	=item $lines_in_scrollback = $term->nsaved	1187	=item $topmost_scrollback_row = $term->top_row
817		1188
818	Return various integers describing terminal characteristics.	1189	Return various integers describing terminal characteristics.
		1190
		1191	=item $x_display = $term->display_id
		1192
		1193	Return the DISPLAY used by rxvt-unicode.
		1194
		1195	=item $lc_ctype = $term->locale
		1196
		1197	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1198
		1199	=item $env = $term->env
		1200
		1201	Returns a copy of the environment in effect for the terminal as a hashref
		1202	similar to C<\%ENV>.
		1203
		1204	=cut
		1205
		1206	sub env {
		1207	if (my $env = $_[0]->_env) {
		1208	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1209	} else {
		1210	+{ %ENV }
		1211	}
		1212	}
819		1213
820	=item $modifiermask = $term->ModLevel3Mask	1214	=item $modifiermask = $term->ModLevel3Mask
821		1215
822	=item $modifiermask = $term->ModMetaMask	1216	=item $modifiermask = $term->ModMetaMask
823		1217
…		…
826	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1220	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
827	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1221	AltGr), the meta key (often Alt) and the num lock key, if applicable.
828		1222
829	=item $view_start = $term->view_start ([$newvalue])	1223	=item $view_start = $term->view_start ([$newvalue])
830		1224
831	Returns the negative row number of the topmost line. Minimum value is	1225	Returns the row number of the topmost displayed line. Maximum value is
832	C<0>, which displays the normal terminal contents. Larger values scroll	1226	C<0>, which displays the normal terminal contents. Lower values scroll
833	this many lines into the scrollback buffer.	1227	this many lines into the scrollback buffer.
834		1228
835	=item $term->want_refresh	1229	=item $term->want_refresh
836		1230
837	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1231	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
916	Return the row number of the first/last row of the line, respectively.	1310	Return the row number of the first/last row of the line, respectively.
917		1311
918	=item $offset = $line->offset_of ($row, $col)	1312	=item $offset = $line->offset_of ($row, $col)
919		1313
920	Returns the character offset of the given row\|col pair within the logical	1314	Returns the character offset of the given row\|col pair within the logical
921	line.	1315	line. Works for rows outside the line, too, and returns corresponding
		1316	offsets outside the string.
922		1317
923	=item ($row, $col) = $line->coord_of ($offset)	1318	=item ($row, $col) = $line->coord_of ($offset)
924		1319
925	Translates a string offset into terminal coordinates again.	1320	Translates a string offset into terminal coordinates again.
926		1321
927	=back	1322	=back
928		1323
929	=cut	1324	=cut
930		1325
931	sub urxvt::term::line {	1326	sub line {
932	my ($self, $row) = @_;	1327	my ($self, $row) = @_;
933		1328
934	my $maxrow = $self->nrow - 1;	1329	my $maxrow = $self->nrow - 1;
935		1330
936	my ($beg, $end) = ($row, $row);	1331	my ($beg, $end) = ($row, $row);
…		…
1000	$offset / $self->{ncol} + $self->{beg},	1395	$offset / $self->{ncol} + $self->{beg},
1001	$offset % $self->{ncol}	1396	$offset % $self->{ncol}
1002	)	1397	)
1003	}	1398	}
1004		1399
1005	=item ($row, $col) = $line->coord_of ($offset)
1006	=item $text = $term->special_encode $string	1400	=item $text = $term->special_encode $string
1007		1401
1008	Converts a perl string into the special encoding used by rxvt-unicode,	1402	Converts a perl string into the special encoding used by rxvt-unicode,
1009	where one character corresponds to one screen cell. See	1403	where one character corresponds to one screen cell. See
1010	C<< $term->ROW_t >> for details.	1404	C<< $term->ROW_t >> for details.
…		…
1012	=item $string = $term->special_decode $text	1406	=item $string = $term->special_decode $text
1013		1407
1014	Converts rxvt-unicodes text reprsentation into a perl string. See	1408	Converts rxvt-unicodes text reprsentation into a perl string. See
1015	C<< $term->ROW_t >> for details.	1409	C<< $term->ROW_t >> for details.
1016		1410
		1411	=item $success = $term->grab_button ($button, $modifiermask)
		1412
		1413	Registers a synchronous button grab. See the XGrabButton manpage.
		1414
		1415	=item $success = $term->grab ($eventtime[, $sync])
		1416
		1417	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1418	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1419
		1420	=item $term->allow_events_async
		1421
		1422	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1423
		1424	=item $term->allow_events_sync
		1425
		1426	Calls XAllowEvents with SyncBoth for the most recent grab.
		1427
		1428	=item $term->allow_events_replay
		1429
		1430	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1431	recent grab.
		1432
		1433	=item $term->ungrab
		1434
		1435	Calls XUngrab for the most recent grab. Is called automatically on
		1436	evaluation errors, as it is better to lose the grab in the error case as
		1437	the session.
		1438
1017	=back	1439	=back
1018		1440
		1441	=cut
		1442
		1443	package urxvt::popup;
		1444
1019	=head2 The C<urxvt::popup> Class	1445	=head2 The C<urxvt::popup> Class
1020		1446
1021	=over 4	1447	=over 4
1022		1448
1023	=cut	1449	=cut
1024
1025	package urxvt::popup;
1026		1450
1027	sub add_item {	1451	sub add_item {
1028	my ($self, $item) = @_;	1452	my ($self, $item) = @_;
1029		1453
1030	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};	1454	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
…		…
1034	$item->{render} \|\|= sub { $_[0]{text} };	1458	$item->{render} \|\|= sub { $_[0]{text} };
1035		1459
1036	push @{ $self->{item} }, $item;	1460	push @{ $self->{item} }, $item;
1037	}	1461	}
1038		1462
1039	sub add_separator {	1463	=item $popup->add_title ($title)
1040	my ($self, $sep) = @_;
1041		1464
1042	$sep \|\|= "═";	1465	Adds a non-clickable title to the popup.
1043		1466
1044	$self->add_item ({	1467	=cut
1045	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1046	text => "",
1047	render => sub { $sep x $urxvt::TERM->ncol },
1048	activate => sub { },
1049	});
1050	}
1051		1468
1052	sub add_title {	1469	sub add_title {
1053	my ($self, $title) = @_;	1470	my ($self, $title) = @_;
1054		1471
1055	$self->add_item ({	1472	$self->add_item ({
…		…
1057	text => $title,	1474	text => $title,
1058	activate => sub { },	1475	activate => sub { },
1059	});	1476	});
1060	}	1477	}
1061		1478
		1479	=item $popup->add_separator ([$sepchr])
		1480
		1481	Creates a separator, optionally using the character given as C<$sepchr>.
		1482
		1483	=cut
		1484
		1485	sub add_separator {
		1486	my ($self, $sep) = @_;
		1487
		1488	$sep \|\|= "=";
		1489
		1490	$self->add_item ({
		1491	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1492	text => "",
		1493	render => sub { $sep x $self->{term}->ncol },
		1494	activate => sub { },
		1495	});
		1496	}
		1497
		1498	=item $popup->add_button ($text, $cb)
		1499
		1500	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1501	selected.
		1502
		1503	=cut
		1504
1062	sub add_button {	1505	sub add_button {
1063	my ($self, $text, $cb) = @_;	1506	my ($self, $text, $cb) = @_;
1064		1507
1065	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1508	$self->add_item ({ type => "button", text => $text, activate => $cb});
1066	}	1509	}
		1510
		1511	=item $popup->add_toggle ($text, $cb, $initial_value)
		1512
		1513	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1514	whenever it gets toggled, with a boolean indicating its value as its first
		1515	argument.
		1516
		1517	=cut
1067		1518
1068	sub add_toggle {	1519	sub add_toggle {
1069	my ($self, $text, $cb, $value) = @_;	1520	my ($self, $text, $cb, $value) = @_;
1070		1521
1071	my $item; $item = {	1522	my $item; $item = {
1072	type => "button",	1523	type => "button",
1073	text => " $text",	1524	text => " $text",
1074	value => $value,	1525	value => $value,
1075	render => sub { ($item->{value} ? "* " : " ") . $text },	1526	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1076	activate => sub { $cb->($item->{value} = !$item->{value}); },	1527	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1077	};	1528	};
1078		1529
1079	$self->add_item ($item);	1530	$self->add_item ($item);
1080	}	1531	}
		1532
		1533	=item $popup->show
		1534
		1535	Displays the popup (which is initially hidden).
		1536
		1537	=cut
1081		1538
1082	sub show {	1539	sub show {
1083	my ($self) = @_;	1540	my ($self) = @_;
1084		1541
1085	local $urxvt::popup::self = $self;	1542	local $urxvt::popup::self = $self;
1086		1543
		1544	my $env = $self->{term}->env;
		1545	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1546	delete $env->{LC_ALL};
		1547	$env->{LC_CTYPE} = $self->{term}->locale;
		1548
		1549	urxvt::term->new ($env, $self->{term}->resource ("name"),
1087	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1550	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1088	"--transient-for" => $self->{term}->parent,	1551	"--transient-for" => $self->{term}->parent,
		1552	"-display" => $self->{term}->display_id,
1089	"-pe" => "urxvt-popup")	1553	"-pe" => "urxvt-popup")
1090	or die "unable to create popup window\n";	1554	or die "unable to create popup window\n";
1091	}	1555	}
1092		1556
1093	sub DESTROY {	1557	sub DESTROY {
1094	my ($self) = @_;	1558	my ($self) = @_;
1095		1559
		1560	delete $self->{term}{_destroy}{$self};
1096	$self->{term}->ungrab;	1561	$self->{term}->ungrab;
1097	}	1562	}
		1563
		1564	=back
1098		1565
1099	=head2 The C<urxvt::timer> Class	1566	=head2 The C<urxvt::timer> Class
1100		1567
1101	This class implements timer watchers/events. Time is represented as a	1568	This class implements timer watchers/events. Time is represented as a
1102	fractional number of seconds since the epoch. Example:	1569	fractional number of seconds since the epoch. Example:
…		…
1155		1622
1156	$term->{socket} = ...	1623	$term->{socket} = ...
1157	$term->{iow} = urxvt::iow	1624	$term->{iow} = urxvt::iow
1158	->new	1625	->new
1159	->fd (fileno $term->{socket})	1626	->fd (fileno $term->{socket})
1160	->events (1) # wait for read data	1627	->events (urxvt::EVENT_READ)
1161	->start	1628	->start
1162	->cb (sub {	1629	->cb (sub {
1163	my ($iow, $revents) = @_;	1630	my ($iow, $revents) = @_;
1164	# $revents must be 1 here, no need to check	1631	# $revents must be 1 here, no need to check
1165	sysread $term->{socket}, my $buf, 8192	1632	sysread $term->{socket}, my $buf, 8192
…		…
1182		1649
1183	Set the filedescriptor (not handle) to watch.	1650	Set the filedescriptor (not handle) to watch.
1184		1651
1185	=item $iow = $iow->events ($eventmask)	1652	=item $iow = $iow->events ($eventmask)
1186		1653
1187	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1654	Set the event mask to watch. The only allowed values are
1188	data, Bit #1 (value C<2>) enables watching for write data.	1655	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1656	together, or C<urxvt::EVENT_NONE>.
1189		1657
1190	=item $iow = $iow->start	1658	=item $iow = $iow->start
1191		1659
1192	Start watching for requested events on the given handle.	1660	Start watching for requested events on the given handle.
1193		1661
…		…
1204	This variable controls the verbosity level of the perl extension. Higher	1672	This variable controls the verbosity level of the perl extension. Higher
1205	numbers indicate more verbose output.	1673	numbers indicate more verbose output.
1206		1674
1207	=over 4	1675	=over 4
1208		1676
1209	=item =0 - only fatal messages	1677	=item == 0 - fatal messages
1210		1678
1211	=item =3 - script loading and management	1679	=item >= 3 - script loading and management
1212		1680
1213	=item =10 - all events received	1681	=item >=10 - all called hooks
		1682
		1683	=item >=11 - hook reutrn values
1214		1684
1215	=back	1685	=back
1216		1686
1217	=head1 AUTHOR	1687	=head1 AUTHOR
1218		1688

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.53 by root, Sun Jan 8 01:16:09 2006 UTC vs. Revision 1.94 by root, Sun Jan 15 06:02:41 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.53 by root, Sun Jan 8 01:16:09 2006 UTC vs.
Revision 1.94 by root, Sun Jan 15 06:02:41 2006 UTC