[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.94 by root, Sun Jan 15 06:02:41 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/^([^:[: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 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_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
		382	=item on_focus_in $term
		383
		384	Called whenever the window gets the keyboard focus, before rxvt-unicode
		385	does focus in processing.
		386
		387	=item on_focus_out $term
		388
		389	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		390	focus out processing.
		391
265	=item on_key_press $term, $event, $octets	392	=item on_key_press $term, $event, $keysym, $octets
266		393
267	=item on_key_release $term, $event	394	=item on_key_release $term, $event, $keysym
268		395
269	=item on_button_press $term, $event	396	=item on_button_press $term, $event
270		397
271	=item on_button_release $term, $event	398	=item on_button_release $term, $event
272		399
273	=item on_motion_notify $term, $event	400	=item on_motion_notify $term, $event
		401
		402	=item on_map_notify $term, $event
		403
		404	=item on_unmap_notify $term, $event
274		405
275	Called whenever the corresponding X event is received for the terminal If	406	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.	407	the hook returns true, then the even will be ignored by rxvt-unicode.
277		408
278	The event is a hash with most values as named by Xlib (see the XEvent	409	The event is a hash with most values as named by Xlib (see the XEvent
…		…
284		415
285	subwindow.	416	subwindow.
286		417
287	=back	418	=back
288		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
289	=head2 Variables in the C<urxvt> Package	441	=head2 Variables in the C<urxvt> Package
290		442
291	=over 4	443	=over 4
292		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>.
		457
293	=item $urxvt::TERM	458	=item $urxvt::TERM
294		459
295	The current terminal. Whenever a callback/Hook is bein executed, this	460	The current terminal. This variable stores the current C<urxvt::term>
296	variable stores the current C<urxvt::term> object.	461	object, whenever a callback/hook is executing.
297		462
298	=back	463	=back
299		464
300	=head2 Functions in the C<urxvt> Package	465	=head2 Functions in the C<urxvt> Package
301		466
302	=over 4	467	=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		468
312	=item urxvt::fatal $errormessage	469	=item urxvt::fatal $errormessage
313		470
314	Fatally aborts execution with the given error message. Avoid at all	471	Fatally aborts execution with the given error message. Avoid at all
315	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
…		…
322	that calls this function.	479	that calls this function.
323		480
324	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
325	correct place, e.g. on stderr of the connecting urxvtc client.	482	correct place, e.g. on stderr of the connecting urxvtc client.
326		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
327	=item $time = urxvt::NOW	492	=item $time = urxvt::NOW
328		493
329	Returns the "current time" (as per the event loop).	494	Returns the "current time" (as per the event loop).
		495
		496	=item urxvt::CurrentTime
		497
		498	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		499	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		500	Button4Mask, Button5Mask, AnyModifier
		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
		518	Various constants for use in X calls and event processing.
330		519
331	=back	520	=back
332		521
333	=head2 RENDITION	522	=head2 RENDITION
334		523
…		…
361		550
362	=item $background = urxvt::GET_BASEBG $rend	551	=item $background = urxvt::GET_BASEBG $rend
363		552
364	Return the foreground/background colour index, respectively.	553	Return the foreground/background colour index, respectively.
365		554
366	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	555	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
367		556
368	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	557	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
369		558
370	Replace the foreground/background colour in the rendition mask with the	559	Replace the foreground/background colour in the rendition mask with the
371	specified one.	560	specified one.
372		561
373	=item $value = urxvt::GET_CUSTOM ($rend)	562	=item $value = urxvt::GET_CUSTOM $rend
374		563
375	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
376	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
377	zero.	566	zero.
378		567
379	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	568	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
380		569
381	Change the custom value.	570	Change the custom value.
382		571
383	=back	572	=back
384		573
385	=cut	574	=cut
386
387	package urxvt;
388
389	use strict;
390	use Scalar::Util ();
391
392	our $TERM;
393	our @HOOKNAME;
394	our $LIBDIR;
395		575
396	BEGIN {	576	BEGIN {
397	urxvt->bootstrap;	577	urxvt->bootstrap;
398		578
399	# overwrite perl's warn	579	# overwrite perl's warn
…		…
401	my $msg = join "", @_;	581	my $msg = join "", @_;
402	$msg .= "\n"	582	$msg .= "\n"
403	unless $msg =~ /\n$/;	583	unless $msg =~ /\n$/;
404	urxvt::warn ($msg);	584	urxvt::warn ($msg);
405	};	585	};
406	}
407		586
408	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
409	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	594	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
410		595
411	sub verbose {	596	sub verbose {
412	my ($level, $msg) = @_;	597	my ($level, $msg) = @_;
413	warn "$msg\n" if $level <= $verbosity;	598	warn "$msg\n" if $level <= $verbosity;
414	}	599	}
415		600
416	# find on_xxx subs in the package and register them	601	my $extension_pkg = "extension0000";
417	# as hooks	602	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		603
436	# load a single script into its own package, once only	604	# load a single script into its own package, once only
437	sub script_package($) {	605	sub extension_package($) {
438	my ($path) = @_;	606	my ($path) = @_;
439		607
440	$script_pkg{$path} \|\|= do {	608	$extension_pkg{$path} \|\|= do {
441	my $pkg = "urxvt::" . ($script_pkg++);	609	my $pkg = "urxvt::" . ($extension_pkg++);
442		610
443	verbose 3, "loading script '$path' into package '$pkg'";	611	verbose 3, "loading extension '$path' into package '$pkg'";
444		612
445	open my $fh, "<:raw", $path	613	open my $fh, "<:raw", $path
446	or die "$path: $!";	614	or die "$path: $!";
447		615
		616	my $source = untaint
448	my $source = "package $pkg; use strict; use utf8;\n"	617	"package $pkg; use strict; use utf8;\n"
		618	. "use base urxvt::term::extension::;\n"
449	. "#line 1 \"$path\"\n{\n"	619	. "#line 1 \"$path\"\n{\n"
450	. (do { local $/; <$fh> })	620	. (do { local $/; <$fh> })
451	. "\n};\n1";	621	. "\n};\n1";
452		622
		623	eval $source
453	eval $source or die "$path: $@";	624	or die "$path: $@";
454		625
455	$pkg	626	$pkg
456	}	627	}
457	}	628	}
458		629
…		…
463	local $TERM = shift;	634	local $TERM = shift;
464	my $htype = shift;	635	my $htype = shift;
465		636
466	if ($htype == 0) { # INIT	637	if ($htype == 0) { # INIT
467	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	638	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		639
		640	my %ext_arg;
468		641
469	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	642	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		643	if ($_ eq "default") {
		644	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		645	} elsif (/^-(.*)$/) {
		646	delete $ext_arg{$1};
		647	} elsif (/^([^<]+)<(.*)>$/) {
		648	push @{ $ext_arg{$1} }, $2;
		649	} else {
		650	$ext_arg{$_} \|\|= [];
		651	}
		652	}
		653
		654	while (my ($ext, $argv) = each %ext_arg) {
470	my @files = grep -f $_, map "$_/$ext", @dirs;	655	my @files = grep -f $_, map "$_/$ext", @dirs;
471		656
472	if (@files) {	657	if (@files) {
473	register_package script_package $files[0];	658	$TERM->register_package (extension_package $files[0], $argv);
474	} else {	659	} else {
475	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";
476	}	661	}
477	}	662	}
		663
		664	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		665	warn $@ if $@;
478	}	666	}
479		667
480	$retval = undef;	668	$retval = undef;
481		669
482	if (my $cb = $TERM->{_hook}[$htype]) {	670	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
484	if $verbosity >= 10;	672	if $verbosity >= 10;
485		673
486	keys %$cb;	674	keys %$cb;
487		675
488	while (my ($pkg, $cb) = each %$cb) {	676	while (my ($pkg, $cb) = each %$cb) {
489	$retval = $cb->(	677	$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;	678	and last;
497	}
498	}
499		679
500	if ($htype == 1) { # DESTROY	680	if ($@) {
501	# remove hooks if unused	681	$TERM->ungrab; # better to lose the grab than the session
502	if (my $hook = $TERM->{_hook}) {	682	warn $@;
503	for my $htype (0..$#$hook) {
504	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
505	or set_should_invoke $htype, 0;
506	}	683	}
507	}	684	}
508		685
		686	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		687	if $verbosity >= 11;
		688	}
		689
		690	if ($htype == 1) { # DESTROY
509	# clear package objects	691	# clear package objects
510	%$_ = () for values %{ $TERM->{_pkg} };	692	%$_ = () for values %{ $TERM->{_pkg} };
511		693
512	# clear package	694	# clear package
513	%$TERM = ();	695	%$TERM = ();
514	}	696	}
515		697
516	$retval	698	$retval
517	}	699	}
518		700
519	sub urxvt::term::proxy::AUTOLOAD {	701	sub exec_async(@) {
520	$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 =~ /:([^:]+)$/
521	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	751	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
522		752
523	eval qq{	753	eval qq{
524	sub $urxvt::term::proxy::AUTOLOAD {	754	sub $AUTOLOAD {
525	my \$proxy = shift;	755	my \$proxy = shift;
526	\$proxy->{term}->$1 (\@_)	756	\$proxy->{term}->$1 (\@_)
527	}	757	}
528	1	758	1
529	} or die "FATAL: unable to compile method forwarder: $@";	759	} or die "FATAL: unable to compile method forwarder: $@";
530		760
531	goto &$urxvt::term::proxy::AUTOLOAD;	761	goto &$AUTOLOAD;
532	}	762	}
		763
		764	sub DESTROY {
		765	# nop
		766	}
		767
		768	# urxvt::destroy_hook
		769
		770	sub urxvt::destroy_hook::DESTROY {
		771	${$_[0]}->();
		772	}
		773
		774	sub urxvt::destroy_hook(&) {
		775	bless \shift, urxvt::destroy_hook::
		776	}
		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;
533		847
534	=head2 The C<urxvt::term> Class	848	=head2 The C<urxvt::term> Class
535		849
536	=over 4	850	=over 4
537		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
538	=item $term->destroy	893	=item $term->destroy
539		894
540	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.
		898
		899	=item $isset = $term->option ($optval[, $set])
		900
		901	Returns true if the option specified by C<$optval> is enabled, and
		902	optionally change it. All option values are stored by name in the hash
		903	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		904
		905	Here is a a likely non-exhaustive list of option names, please see the
		906	source file F</src/optinc.h> to see the actual list:
		907
		908	borderLess console cursorBlink cursorUnderline hold iconic insecure
		909	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		910	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		911	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		912	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		913	tripleclickwords utmpInhibit visualBell
541		914
542	=item $value = $term->resource ($name[, $newval])	915	=item $value = $term->resource ($name[, $newval])
543		916
544	Returns the current resource value associated with a given name and	917	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>	918	optionally sets a new value. Setting values is most useful in the C<init>
…		…
555		928
556	Please note that resource strings will currently only be freed when the	929	Please note that resource strings will currently only be freed when the
557	terminal is destroyed, so changing options frequently will eat memory.	930	terminal is destroyed, so changing options frequently will eat memory.
558		931
559	Here is a a likely non-exhaustive list of resource names, not all of which	932	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	933	are supported in every build, please see the source file F</src/rsinc.h>
561	list:	934	to see the actual list:
562		935
563	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	936	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
564	borderLess color cursorBlink cursorUnderline cutchars delete_key	937	borderLess color cursorBlink cursorUnderline cutchars delete_key
565	display_name embed ext_bwidth fade font geometry hold iconName	938	display_name embed ext_bwidth fade font geometry hold iconName
566	imFont imLocale inputMethod insecure int_bwidth intensityStyles	939	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
573	shade term_name title transparent transparent_all tripleclickwords	946	shade term_name title transparent transparent_all tripleclickwords
574	utmpInhibit visualBell	947	utmpInhibit visualBell
575		948
576	=cut	949	=cut
577		950
578	sub urxvt::term::resource($$;$) {	951	sub resource($$;$) {
579	my ($self, $name) = (shift, shift);	952	my ($self, $name) = (shift, shift);
580	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	953	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
581	goto &urxvt::term::_resource;	954	&urxvt::term::_resource
582	}	955	}
		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.
583		972
584	=item $rend = $term->rstyle ([$new_rstyle])	973	=item $rend = $term->rstyle ([$new_rstyle])
585		974
586	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
587	the terminal application will use this style.	976	the terminal application will use this style.
…		…
598	=item ($row, $col) = $term->selection_end ([$row, $col])	987	=item ($row, $col) = $term->selection_end ([$row, $col])
599		988
600	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,
601	and optionally set them to new values.	990	and optionally set them to new values.
602		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
603	=item $success = $term->selection_grab ($eventtime)	999	=item $success = $term->selection_grab ($eventtime)
604		1000
605	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
606	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.
607		1004
608	=item $oldtext = $term->selection ([$newtext])	1005	=item $oldtext = $term->selection ([$newtext])
609		1006
610	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>.
611		1008
612	#=item $term->overlay ($x, $y, $text)	1009	=item $term->overlay_simple ($x, $y, $text)
613	#	1010
614	#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.
615	#	1012
616	#=cut	1013	=cut
617	#	1014
618	#sub urxvt::term::scr_overlay {	1015	sub overlay_simple {
619	# my ($self, $x, $y, $text) = @_;	1016	my ($self, $x, $y, $text) = @_;
620	#	1017
621	# my @lines = split /\n/, $text;	1018	my @lines = split /\n/, $text;
622	#	1019
623	# my $w = 0;	1020	my $w = List::Util::max map $self->strwidth ($_), @lines;
624	# for (map $self->strwidth ($_), @lines) {	1021
625	# $w = $_ if $w < $_;
626	# }
627	#
628	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1022	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
629	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1023	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
630	#}	1024
		1025	$overlay
		1026	}
631		1027
632	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1028	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
633		1029
634	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
635	width/height. C<$rstyle> defines the initial rendition style	1031	width/height. C<$rstyle> defines the initial rendition style
…		…
662		1058
663	If hidden, display the overlay again.	1059	If hidden, display the overlay again.
664		1060
665	=back	1061	=back
666		1062
		1063	=item $popup = $term->popup ($event)
		1064
		1065	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1066	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1067	currently).
		1068
		1069	=cut
		1070
		1071	sub popup {
		1072	my ($self, $event) = @_;
		1073
		1074	$self->grab ($event->{time}, 1)
		1075	or return;
		1076
		1077	my $popup = bless {
		1078	term => $self,
		1079	event => $event,
		1080	}, urxvt::popup::;
		1081
		1082	Scalar::Util::weaken $popup->{term};
		1083
		1084	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1085	Scalar::Util::weaken $self->{_destroy}{$popup};
		1086
		1087	$popup
		1088	}
		1089
667	=item $cellwidth = $term->strwidth ($string)	1090	=item $cellwidth = $term->strwidth ($string)
668		1091
669	Returns the number of screen-cells this string would need. Correctly	1092	Returns the number of screen-cells this string would need. Correctly
670	accounts for wide and combining characters.	1093	accounts for wide and combining characters.
671		1094
…		…
674	Convert the given text string into the corresponding locale encoding.	1097	Convert the given text string into the corresponding locale encoding.
675		1098
676	=item $string = $term->locale_decode ($octets)	1099	=item $string = $term->locale_decode ($octets)
677		1100
678	Convert the given locale-encoded octets into a perl string.	1101	Convert the given locale-encoded octets into a perl string.
		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!
679		1119
680	=item $term->scr_add_lines ($string)	1120	=item $term->scr_add_lines ($string)
681		1121
682	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
683	running inside the terminal. It may not contain command sequences (escape	1123	running inside the terminal. It may not contain command sequences (escape
…		…
698		1138
699	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
700	pass characters instead of octets, you should convert your strings first	1140	pass characters instead of octets, you should convert your strings first
701	to the locale-specific encoding using C<< $term->locale_encode >>.	1141	to the locale-specific encoding using C<< $term->locale_encode >>.
702		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
703	=item $windowid = $term->parent	1150	=item $windowid = $term->parent
704		1151
705	Return the window id of the toplevel window.	1152	Return the window id of the toplevel window.
706		1153
707	=item $windowid = $term->vt	1154	=item $windowid = $term->vt
708		1155
709	Return the window id of the terminal window.	1156	Return the window id of the terminal window.
710		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
711	=item $window_width = $term->width	1165	=item $window_width = $term->width
712		1166
713	=item $window_height = $term->height	1167	=item $window_height = $term->height
714		1168
715	=item $font_width = $term->fwidth	1169	=item $font_width = $term->fwidth
…		…
728		1182
729	=item $max_scrollback = $term->saveLines	1183	=item $max_scrollback = $term->saveLines
730		1184
731	=item $nrow_plus_saveLines = $term->total_rows	1185	=item $nrow_plus_saveLines = $term->total_rows
732		1186
733	=item $lines_in_scrollback = $term->nsaved	1187	=item $topmost_scrollback_row = $term->top_row
734		1188
735	Return various integers describing terminal characteristics.	1189	Return various integers describing terminal characteristics.
736		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	}
		1213
		1214	=item $modifiermask = $term->ModLevel3Mask
		1215
		1216	=item $modifiermask = $term->ModMetaMask
		1217
		1218	=item $modifiermask = $term->ModNumLockMask
		1219
		1220	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1221	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1222
737	=item $view_start = $term->view_start ([$newvalue])	1223	=item $view_start = $term->view_start ([$newvalue])
738		1224
739	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
740	C<0>, which displays the normal terminal contents. Larger values scroll	1226	C<0>, which displays the normal terminal contents. Lower values scroll
741	this many lines into the scrollback buffer.	1227	this many lines into the scrollback buffer.
742		1228
743	=item $term->want_refresh	1229	=item $term->want_refresh
744		1230
745	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1231	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
824	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.
825		1311
826	=item $offset = $line->offset_of ($row, $col)	1312	=item $offset = $line->offset_of ($row, $col)
827		1313
828	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
829	line.	1315	line. Works for rows outside the line, too, and returns corresponding
		1316	offsets outside the string.
830		1317
831	=item ($row, $col) = $line->coord_of ($offset)	1318	=item ($row, $col) = $line->coord_of ($offset)
832		1319
833	Translates a string offset into terminal coordinates again.	1320	Translates a string offset into terminal coordinates again.
834		1321
835	=back	1322	=back
836		1323
837	=cut	1324	=cut
838		1325
839	sub urxvt::term::line {	1326	sub line {
840	my ($self, $row) = @_;	1327	my ($self, $row) = @_;
841		1328
842	my $maxrow = $self->nrow - 1;	1329	my $maxrow = $self->nrow - 1;
843		1330
844	my ($beg, $end) = ($row, $row);	1331	my ($beg, $end) = ($row, $row);
…		…
908	$offset / $self->{ncol} + $self->{beg},	1395	$offset / $self->{ncol} + $self->{beg},
909	$offset % $self->{ncol}	1396	$offset % $self->{ncol}
910	)	1397	)
911	}	1398	}
912		1399
913	=item ($row, $col) = $line->coord_of ($offset)
914	=item $text = $term->special_encode $string	1400	=item $text = $term->special_encode $string
915		1401
916	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,
917	where one character corresponds to one screen cell. See	1403	where one character corresponds to one screen cell. See
918	C<< $term->ROW_t >> for details.	1404	C<< $term->ROW_t >> for details.
919		1405
920	=item $string = $term->special_decode $text	1406	=item $string = $term->special_decode $text
921		1407
922	Converts rxvt-unicodes text reprsentation into a perl string. See	1408	Converts rxvt-unicodes text reprsentation into a perl string. See
923	C<< $term->ROW_t >> for details.	1409	C<< $term->ROW_t >> for details.
		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
		1439	=back
		1440
		1441	=cut
		1442
		1443	package urxvt::popup;
		1444
		1445	=head2 The C<urxvt::popup> Class
		1446
		1447	=over 4
		1448
		1449	=cut
		1450
		1451	sub add_item {
		1452	my ($self, $item) = @_;
		1453
		1454	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1455	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1456	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1457
		1458	$item->{render} \|\|= sub { $_[0]{text} };
		1459
		1460	push @{ $self->{item} }, $item;
		1461	}
		1462
		1463	=item $popup->add_title ($title)
		1464
		1465	Adds a non-clickable title to the popup.
		1466
		1467	=cut
		1468
		1469	sub add_title {
		1470	my ($self, $title) = @_;
		1471
		1472	$self->add_item ({
		1473	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1474	text => $title,
		1475	activate => sub { },
		1476	});
		1477	}
		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
		1505	sub add_button {
		1506	my ($self, $text, $cb) = @_;
		1507
		1508	$self->add_item ({ type => "button", text => $text, activate => $cb});
		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
		1518
		1519	sub add_toggle {
		1520	my ($self, $text, $cb, $value) = @_;
		1521
		1522	my $item; $item = {
		1523	type => "button",
		1524	text => " $text",
		1525	value => $value,
		1526	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1527	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1528	};
		1529
		1530	$self->add_item ($item);
		1531	}
		1532
		1533	=item $popup->show
		1534
		1535	Displays the popup (which is initially hidden).
		1536
		1537	=cut
		1538
		1539	sub show {
		1540	my ($self) = @_;
		1541
		1542	local $urxvt::popup::self = $self;
		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"),
		1550	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1551	"--transient-for" => $self->{term}->parent,
		1552	"-display" => $self->{term}->display_id,
		1553	"-pe" => "urxvt-popup")
		1554	or die "unable to create popup window\n";
		1555	}
		1556
		1557	sub DESTROY {
		1558	my ($self) = @_;
		1559
		1560	delete $self->{term}{_destroy}{$self};
		1561	$self->{term}->ungrab;
		1562	}
924		1563
925	=back	1564	=back
926		1565
927	=head2 The C<urxvt::timer> Class	1566	=head2 The C<urxvt::timer> Class
928		1567
…		…
983		1622
984	$term->{socket} = ...	1623	$term->{socket} = ...
985	$term->{iow} = urxvt::iow	1624	$term->{iow} = urxvt::iow
986	->new	1625	->new
987	->fd (fileno $term->{socket})	1626	->fd (fileno $term->{socket})
988	->events (1) # wait for read data	1627	->events (urxvt::EVENT_READ)
989	->start	1628	->start
990	->cb (sub {	1629	->cb (sub {
991	my ($iow, $revents) = @_;	1630	my ($iow, $revents) = @_;
992	# $revents must be 1 here, no need to check	1631	# $revents must be 1 here, no need to check
993	sysread $term->{socket}, my $buf, 8192	1632	sysread $term->{socket}, my $buf, 8192
…		…
1010		1649
1011	Set the filedescriptor (not handle) to watch.	1650	Set the filedescriptor (not handle) to watch.
1012		1651
1013	=item $iow = $iow->events ($eventmask)	1652	=item $iow = $iow->events ($eventmask)
1014		1653
1015	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
1016	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>.
1017		1657
1018	=item $iow = $iow->start	1658	=item $iow = $iow->start
1019		1659
1020	Start watching for requested events on the given handle.	1660	Start watching for requested events on the given handle.
1021		1661
…		…
1032	This variable controls the verbosity level of the perl extension. Higher	1672	This variable controls the verbosity level of the perl extension. Higher
1033	numbers indicate more verbose output.	1673	numbers indicate more verbose output.
1034		1674
1035	=over 4	1675	=over 4
1036		1676
1037	=item =0 - only fatal messages	1677	=item == 0 - fatal messages
1038		1678
1039	=item =3 - script loading and management	1679	=item >= 3 - script loading and management
1040		1680
1041	=item =10 - all events received	1681	=item >=10 - all called hooks
		1682
		1683	=item >=11 - hook reutrn values
1042		1684
1043	=back	1685	=back
1044		1686
1045	=head1 AUTHOR	1687	=head1 AUTHOR
1046		1688

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.94 by root, Sun Jan 15 06:02:41 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.94 by root, Sun Jan 15 06:02:41 2006 UTC