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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC vs.
Revision 1.101 by root, Wed Jan 18 10:11:03 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 following bindable keyboard commands:
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	Other extensions can extend this popup menu by pushing a code reference onto
		95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
		96
		97	It's sole argument is the popup menu, which can be modified. The selection
		98	is in C<$_>, which can be used to decide wether to add something or not.
		99	It should either return nothing or a string and a code reference. The
		100	string will be used as button text and the code reference will be called
		101	when the button gets activated and should transform C<$_>.
		102
		103	The following will add an entry C<a to b> that transforms all C<a>s in
		104	the selection to C<b>s, but only if the selection currently contains any
		105	C<a>s:
		106
		107	push urxvt::ext::selection_popup::hook, sub {
		108	/a/ ? ("a to be" => sub { s/a/b/g }
		109	: ()
		110	};
		111
		112	=item searchable-scrollback<hotkey> (enabled by default)
		113
		114	Adds regex search functionality to the scrollback buffer, triggered
		115	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		116	input/output is suspended and a regex is displayed at the bottom of the
		117	screen.
		118
		119	Inputting characters appends them to the regex and continues incremental
		120	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		121	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		122	bottom. C<Escape> leaves search mode and returns to the point where search
		123	was started, while C<Enter> or C<Return> stay at the current position and
		124	additionally stores the first match in the current line into the primary
		125	selection.
		126
		127	=item selection-autotransform
		128
		129	This selection allows you to do automatic transforms on a selection
		130	whenever a selection is made.
		131
		132	It works by specifying perl snippets (most useful is a single C<s///>
		133	operator) that modify C<$_> as resources:
		134
		135	URxvt.selection-autotransform.0: transform
		136	URxvt.selection-autotransform.1: transform
		137	...
		138
		139	For example, the following will transform selections of the form
		140	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		141	$word>:
		142
		143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		144
		145	And this example matches the same,but replaces it with vi-commands you can
		146	paste directly into your (vi :) editor:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		149
		150	Of course, this can be modified to suit your needs and your editor :)
		151
		152	To expand the example above to typical perl error messages ("XXX at
		153	FILENAME line YYY."), you need a slightly more elaborate solution:
		154
		155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		157
		158	The first line tells the selection code to treat the unchanging part of
		159	every error message as a selection pattern, and the second line transforms
		160	the message into vi commands to load the file.
64		161
65	=item mark-urls	162	=item mark-urls
66		163
67	Uses per-line display filtering (C<on_line_update>) to underline urls.	164	Uses per-line display filtering (C<on_line_update>) to underline urls and
		165	make them clickable. When middle-clicked, the program specified in the
		166	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		167	the URL as first argument.
68		168
69	=item block-graphics-to-ascii	169	=item block-graphics-to-ascii
70		170
71	A not very useful example of filtering all text output to the terminal,	171	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	172	by replacing all line-drawing characters (U+2500 .. U+259F) by a
73	similar-looking ascii character.	173	similar-looking ascii character.
74		174
		175	=item digital-clock
		176
		177	Displays a digital clock using the built-in overlay.
		178
75	=item example-refresh-hooks	179	=item example-refresh-hooks
76		180
77	Displays a very simple digital clock in the upper right corner of the	181	Displays a very simple digital clock in the upper right corner of the
78	window. Illustrates overwriting the refresh callbacks to create your own	182	window. Illustrates overwriting the refresh callbacks to create your own
79	overlays or changes.	183	overlays or changes.
80		184
		185	=item selection-pastebin
		186
		187	This is a little rarely useful extension that Uploads the selection as
		188	textfile to a remote site (or does other things). (The implementation is
		189	not currently secure for use in a multiuser environment as it writes to
		190	F</tmp> directly.).
		191
		192	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		193	i.e.
		194
		195	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		196
		197	Pressing this combination runs a command with C<%> replaced by the name of
		198	the textfile. This command can be set via a resource:
		199
		200	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		201
		202	And the default is likely not useful to anybody but the few people around
		203	here :)
		204
		205	The name of the textfile is the hex encoded md5 sum of the selection, so
		206	the same content should lead to the same filename.
		207
		208	After a successful upload the selection will be replaced by the text given
		209	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		210	for the filename):
		211
		212	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		213
81	=back	214	=back
		215
		216	=head1 API DOCUMENTATION
82		217
83	=head2 General API Considerations	218	=head2 General API Considerations
84		219
85	All objects (such as terminals, time watchers etc.) are typical	220	All objects (such as terminals, time watchers etc.) are typical
86	reference-to-hash objects. The hash can be used to store anything you	221	reference-to-hash objects. The hash can be used to store anything you
…		…
99	=over 4	234	=over 4
100		235
101	=item $text	236	=item $text
102		237
103	Rxvt-unicodes special way of encoding text, where one "unicode" character	238	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.	239	always represents one screen cell. See L<ROW_t> for a discussion of this format.
105		240
106	=item $string	241	=item $string
107		242
108	A perl text string, with an emphasis on I<text>. It can store all unicode	243	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	244	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	249	Either binary data or - more common - a text string encoded in a
115	locale-specific way.	250	locale-specific way.
116		251
117	=back	252	=back
118		253
		254	=head2 Extension Objects
		255
		256	Very perl extension is a perl class. A separate perl object is created
		257	for each terminal and each extension and passed as the first parameter to
		258	hooks. So extensions can use their C<$self> object without having to think
		259	about other extensions, with the exception of methods and members that
		260	begin with an underscore character C<_>: these are reserved for internal
		261	use.
		262
		263	Although it isn't a C<urxvt::term> object, you can call all methods of the
		264	C<urxvt::term> class on this object.
		265
		266	It has the following methods and data members:
		267
		268	=over 4
		269
		270	=item $urxvt_term = $self->{term}
		271
		272	Returns the C<urxvt::term> object associated with this instance of the
		273	extension. This member I<must not> be changed in any way.
		274
		275	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		276
		277	Dynamically enable the given hooks (named without the C<on_> prefix) for
		278	this extension, replacing any previous hook. This is useful when you want
		279	to overwrite time-critical hooks only temporarily.
		280
		281	=item $self->disable ($hook_name[, $hook_name..])
		282
		283	Dynamically disable the given hooks.
		284
		285	=back
		286
119	=head2 Hooks	287	=head2 Hooks
120		288
121	The following subroutines can be declared in extension files, and will be	289	The following subroutines can be declared in extension files, and will be
122	called whenever the relevant event happens.	290	called whenever the relevant event happens.
123		291
124	The first argument passed to them is an object private to each terminal	292	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	293	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		294
131	All of them must return a boolean value. If it is true, then the event	295	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,	296	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.	297	skipped, and the relevant action might not be carried out by the C++ code.
134		298
135	When in doubt, return a false value (preferably C<()>).	299	I<< When in doubt, return a false value (preferably C<()>). >>
136		300
137	=over 4	301	=over 4
138		302
139	=item on_init $term	303	=item on_init $term
140		304
…		…
175	=item on_sel_extend $term	339	=item on_sel_extend $term
176		340
177	Called whenever the user tries to extend the selection (e.g. with a double	341	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	342	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	343	should extend the selection itelf and return true to suppress the built-in
180	processing.	344	processing. This can happen multiple times, as long as the callback
		345	returns true, it will be called on every further click by the user and is
		346	supposed to enlarge the selection more and more, if possible.
181		347
182	See the F<selection> example extension.	348	See the F<selection> example extension.
183		349
184	=item on_view_change $term, $offset	350	=item on_view_change $term, $offset
185		351
…		…
194	than the scroll back buffer or the terminal.	360	than the scroll back buffer or the terminal.
195		361
196	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	362	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	363	$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.	364	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		365
204	=item on_osc_seq $term, $string	366	=item on_osc_seq $term, $string
205		367
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	368	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	369	operating system command) is processed. Cursor position and other state
…		…
220	can filter/change and output the text yourself by returning a true value	382	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	383	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	384	might be very slow, however, as your hook is called for B<all> text being
223	output.	385	output.
224		386
		387	=item on_tt_write $term, $octets
		388
		389	Called whenever some data is written to the tty/pty and can be used to
		390	suppress or filter tty input.
		391
225	=item on_line_update $term, $row	392	=item on_line_update $term, $row
226		393
227	Called whenever a line was updated or changed. Can be used to filter	394	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	395	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,	396	that are being shown will be filtered, and, due to performance reasons,
…		…
251		418
252	Called whenever the user presses a key combination that has a	419	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>	420	C<perl:string> action bound to it (see description of the B<keysym>
254	resource in the @@RXVT_NAME@@(1) manpage).	421	resource in the @@RXVT_NAME@@(1) manpage).
255		422
		423	=item on_x_event $term, $event
		424
		425	Called on every X event received on the vt window (and possibly other
		426	windows). Should only be used as a last resort. Most event structure
		427	members are not passed.
		428
256	=item on_focus_in $term	429	=item on_focus_in $term
257		430
258	Called whenever the window gets the keyboard focus, before rxvt-unicode	431	Called whenever the window gets the keyboard focus, before rxvt-unicode
259	does focus in processing.	432	does focus in processing.
260		433
261	=item on_focus_out $term	434	=item on_focus_out $term
262		435
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	436	Called wheneever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	437	focus out processing.
265		438
266	=item on_key_press $term, $event, $octets	439	=item on_key_press $term, $event, $keysym, $octets
267		440
268	=item on_key_release $term, $event	441	=item on_key_release $term, $event, $keysym
269		442
270	=item on_button_press $term, $event	443	=item on_button_press $term, $event
271		444
272	=item on_button_release $term, $event	445	=item on_button_release $term, $event
273		446
…		…
289		462
290	subwindow.	463	subwindow.
291		464
292	=back	465	=back
293		466
		467	=cut
		468
		469	package urxvt;
		470
		471	use utf8;
		472	use strict;
		473	use Carp ();
		474	use Scalar::Util ();
		475	use List::Util ();
		476
		477	our $VERSION = 1;
		478	our $TERM;
		479	our @HOOKNAME;
		480	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		481	our %OPTION;
		482
		483	our $LIBDIR;
		484	our $RESNAME;
		485	our $RESCLASS;
		486	our $RXVTNAME;
		487
294	=head2 Variables in the C<urxvt> Package	488	=head2 Variables in the C<urxvt> Package
295		489
296	=over 4	490	=over 4
		491
		492	=item $urxvt::LIBDIR
		493
		494	The rxvt-unicode library directory, where, among other things, the perl
		495	modules and scripts are stored.
		496
		497	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		498
		499	The resource class and name rxvt-unicode uses to look up X resources.
		500
		501	=item $urxvt::RXVTNAME
		502
		503	The basename of the installed binaries, usually C<urxvt>.
297		504
298	=item $urxvt::TERM	505	=item $urxvt::TERM
299		506
300	The current terminal. This variable stores the current C<urxvt::term>	507	The current terminal. This variable stores the current C<urxvt::term>
301	object, whenever a callback/hook is executing.	508	object, whenever a callback/hook is executing.
…		…
303	=back	510	=back
304		511
305	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
306		513
307	=over 4	514	=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		515
317	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
318		517
319	Fatally aborts execution with the given error message. Avoid at all	518	Fatally aborts execution with the given error message. Avoid at all
320	costs! The only time this is acceptable is when the terminal process	519	costs! The only time this is acceptable is when the terminal process
…		…
327	that calls this function.	526	that calls this function.
328		527
329	Using this function has the advantage that its output ends up in the	528	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.	529	correct place, e.g. on stderr of the connecting urxvtc client.
331		530
		531	Messages have a size limit of 1023 bytes currently.
		532
332	=item $time = urxvt::NOW	533	=item $time = urxvt::NOW
333		534
334	Returns the "current time" (as per the event loop).	535	Returns the "current time" (as per the event loop).
335		536
336	=item urxvt::CurrentTime	537	=item urxvt::CurrentTime
337		538
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	539	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	540	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	541	Button4Mask, Button5Mask, AnyModifier
341		542
		543	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		544	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		545	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		546	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		547	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		548	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		549	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		550
		551	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		552	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		553	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		554	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		555	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		556	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		557	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		558
342	Various constants for use in X events.	559	Various constants for use in X calls and event processing.
343		560
344	=back	561	=back
345		562
346	=head2 RENDITION	563	=head2 RENDITION
347		564
…		…
374		591
375	=item $background = urxvt::GET_BASEBG $rend	592	=item $background = urxvt::GET_BASEBG $rend
376		593
377	Return the foreground/background colour index, respectively.	594	Return the foreground/background colour index, respectively.
378		595
379	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	596	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
380		597
381	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	598	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
382		599
383	Replace the foreground/background colour in the rendition mask with the	600	Replace the foreground/background colour in the rendition mask with the
384	specified one.	601	specified one.
385		602
386	=item $value = urxvt::GET_CUSTOM ($rend)	603	=item $value = urxvt::GET_CUSTOM $rend
387		604
388	Return the "custom" value: Every rendition has 5 bits for use by	605	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	606	extensions. They can be set and changed as you like and are initially
390	zero.	607	zero.
391		608
392	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	609	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
393		610
394	Change the custom value.	611	Change the custom value.
395		612
396	=back	613	=back
397		614
398	=cut	615	=cut
399		616
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 $LIBDIR;
410
411	BEGIN {	617	BEGIN {
412	urxvt->bootstrap;
413
414	# overwrite perl's warn	618	# overwrite perl's warn
415	*CORE::GLOBAL::warn = sub {	619	*CORE::GLOBAL::warn = sub {
416	my $msg = join "", @_;	620	my $msg = join "", @_;
417	$msg .= "\n"	621	$msg .= "\n"
418	unless $msg =~ /\n$/;	622	unless $msg =~ /\n$/;
419	urxvt::warn ($msg);	623	urxvt::warn ($msg);
420	};	624	};
421	}
422		625
423	my @hook_count;	626	# %ENV is the original startup environment
		627	delete $ENV{IFS};
		628	delete $ENV{CDPATH};
		629	delete $ENV{BASH_ENV};
		630	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
		631	}
		632
424	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	633	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
425		634
426	sub verbose {	635	sub verbose {
427	my ($level, $msg) = @_;	636	my ($level, $msg) = @_;
428	warn "$msg\n" if $level <= $verbosity;	637	warn "$msg\n" if $level <= $verbosity;
429	}	638	}
430		639
431	# find on_xxx subs in the package and register them
432	# as hooks
433	sub register_package($) {
434	my ($pkg) = @_;
435
436	for my $htype (0.. $#HOOKNAME) {
437	my $name = $HOOKNAME[$htype];
438
439	my $ref = $pkg->can ("on_" . lc $name)
440	or next;
441
442	$TERM->{_hook}[$htype]{$pkg} = $ref;
443	$hook_count[$htype]++
444	or set_should_invoke $htype, 1;
445	}
446	}
447
448	my $extension_pkg = "extension0000";
449	my %extension_pkg;	640	my %extension_pkg;
450		641
451	# load a single script into its own package, once only	642	# load a single script into its own package, once only
452	sub extension_package($) {	643	sub extension_package($) {
453	my ($path) = @_;	644	my ($path) = @_;
454		645
		646	no strict 'refs';
		647
455	$extension_pkg{$path} \|\|= do {	648	$extension_pkg{$path} \|\|= do {
456	my $pkg = "urxvt::" . ($extension_pkg++);	649	$path =~ /([^\/\\]+)$/;
		650	my $pkg = $1;
		651	$pkg =~ s/[^[:word:]]/_/g;
		652	$pkg = "urxvt::ext::$pkg";
457		653
458	verbose 3, "loading extension '$path' into package '$pkg'";	654	verbose 3, "loading extension '$path' into package '$pkg'";
459		655
460	open my $fh, "<:raw", $path	656	open my $fh, "<:raw", $path
461	or die "$path: $!";	657	or die "$path: $!";
462		658
		659	@{"$pkg\::ISA"} = urxvt::term::extension::;
		660
		661	my $source =
463	my $source = "package $pkg; use strict; use utf8;\n"	662	"package $pkg; use strict; use utf8;\n"
464	. "use base urxvt::term::proxy::;\n"
465	. "#line 1 \"$path\"\n{\n"	663	. "#line 1 \"$path\"\n{\n"
466	. (do { local $/; <$fh> })	664	. (do { local $/; <$fh> })
467	. "\n};\n1";	665	. "\n};\n1";
468		666
		667	eval $source
469	eval $source or die "$path: $@";	668	or die "$path: $@";
470		669
471	$pkg	670	$pkg
472	}	671	}
473	}	672	}
474		673
…		…
479	local $TERM = shift;	678	local $TERM = shift;
480	my $htype = shift;	679	my $htype = shift;
481		680
482	if ($htype == 0) { # INIT	681	if ($htype == 0) { # INIT
483	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	682	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		683
		684	my %ext_arg;
484		685
485	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	686	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		687	if ($_ eq "default") {
		688	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		689	} elsif (/^-(.*)$/) {
		690	delete $ext_arg{$1};
		691	} elsif (/^([^<]+)<(.*)>$/) {
		692	push @{ $ext_arg{$1} }, $2;
		693	} else {
		694	$ext_arg{$_} \|\|= [];
		695	}
		696	}
		697
		698	while (my ($ext, $argv) = each %ext_arg) {
486	my @files = grep -f $_, map "$_/$ext", @dirs;	699	my @files = grep -f $_, map "$_/$ext", @dirs;
487		700
488	if (@files) {	701	if (@files) {
489	register_package extension_package $files[0];	702	$TERM->register_package (extension_package $files[0], $argv);
490	} else {	703	} else {
491	warn "perl extension '$ext' not found in perl library search path\n";	704	warn "perl extension '$ext' not found in perl library search path\n";
492	}	705	}
493	}	706	}
		707
		708	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		709	warn $@ if $@;
494	}	710	}
495		711
496	$retval = undef;	712	$retval = undef;
497		713
498	if (my $cb = $TERM->{_hook}[$htype]) {	714	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
500	if $verbosity >= 10;	716	if $verbosity >= 10;
501		717
502	keys %$cb;	718	keys %$cb;
503		719
504	while (my ($pkg, $cb) = each %$cb) {	720	while (my ($pkg, $cb) = each %$cb) {
505	eval {	721	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
506	$retval = $cb->(
507	$TERM->{_pkg}{$pkg} \|\|= do {
508	my $proxy = bless { }, $pkg;
509	Scalar::Util::weaken ($proxy->{term} = $TERM);
510	$proxy
511	},
512	@_,
513	) and last;	722	and last;
514	};
515	warn $@ if $@;#d#
516	}
517	}
518		723
519	if ($htype == 1) { # DESTROY	724	if ($@) {
520	# remove hooks if unused	725	$TERM->ungrab; # better to lose the grab than the session
521	if (my $hook = $TERM->{_hook}) {	726	warn $@;
522	for my $htype (0..$#$hook) {
523	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
524	or set_should_invoke $htype, 0;
525	}	727	}
526	}	728	}
527		729
		730	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		731	if $verbosity >= 11;
		732	}
		733
		734	if ($htype == 1) { # DESTROY
528	# clear package objects	735	# clear package objects
529	%$_ = () for values %{ $TERM->{_pkg} };	736	%$_ = () for values %{ $TERM->{_pkg} };
530		737
531	# clear package	738	# clear package
532	%$TERM = ();	739	%$TERM = ();
533	}	740	}
534		741
535	$retval	742	$retval
536	}	743	}
537		744
538	sub urxvt::term::proxy::AUTOLOAD {	745	sub exec_async(@) {
539	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	746	my $pid = fork;
		747
		748	return
		749	if !defined $pid or $pid;
		750
		751	%ENV = %{ $TERM->env };
		752
		753	exec @_;
		754	_exit 255;
		755	}
		756
		757	# urxvt::term::extension
		758
		759	package urxvt::term::extension;
		760
		761	sub enable {
		762	my ($self, %hook) = @_;
		763	my $pkg = $self->{_pkg};
		764
		765	while (my ($name, $cb) = each %hook) {
		766	my $htype = $HOOKTYPE{uc $name};
		767	defined $htype
		768	or Carp::croak "unsupported hook type '$name'";
		769
		770	$self->set_should_invoke ($htype, +1)
		771	unless exists $self->{term}{_hook}[$htype]{$pkg};
		772
		773	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		774	}
		775	}
		776
		777	sub disable {
		778	my ($self, @hook) = @_;
		779	my $pkg = $self->{_pkg};
		780
		781	for my $name (@hook) {
		782	my $htype = $HOOKTYPE{uc $name};
		783	defined $htype
		784	or Carp::croak "unsupported hook type '$name'";
		785
		786	$self->set_should_invoke ($htype, -1)
		787	if delete $self->{term}{_hook}[$htype]{$pkg};
		788	}
		789	}
		790
		791	our $AUTOLOAD;
		792
		793	sub AUTOLOAD {
		794	$AUTOLOAD =~ /:([^:]+)$/
540	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	795	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
541		796
542	eval qq{	797	eval qq{
543	sub $urxvt::term::proxy::AUTOLOAD {	798	sub $AUTOLOAD {
544	my \$proxy = shift;	799	my \$proxy = shift;
545	\$proxy->{term}->$1 (\@_)	800	\$proxy->{term}->$1 (\@_)
546	}	801	}
547	1	802	1
548	} or die "FATAL: unable to compile method forwarder: $@";	803	} or die "FATAL: unable to compile method forwarder: $@";
549		804
550	goto &$urxvt::term::proxy::AUTOLOAD;	805	goto &$AUTOLOAD;
551	}	806	}
		807
		808	sub DESTROY {
		809	# nop
		810	}
		811
		812	# urxvt::destroy_hook
552		813
553	sub urxvt::destroy_hook::DESTROY {	814	sub urxvt::destroy_hook::DESTROY {
554	${$_[0]}->();	815	${$_[0]}->();
555	}	816	}
556		817
557	sub urxvt::destroy_hook(&) {	818	sub urxvt::destroy_hook(&) {
558	bless \shift, urxvt::destroy_hook::	819	bless \shift, urxvt::destroy_hook::
559	}	820	}
560		821
		822	package urxvt::anyevent;
		823
		824	=head2 The C<urxvt::anyevent> Class
		825
		826	The sole purpose of this class is to deliver an interface to the
		827	C<AnyEvent> module - any module using it will work inside urxvt without
		828	further programming. The only exception is that you cannot wait on
		829	condition variables, but non-blocking condvar use is ok. What this means
		830	is that you cannot use blocking APIs, but the non-blocking variant should
		831	work.
		832
		833	=cut
		834
		835	our $VERSION = 1;
		836
		837	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		838	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		839
		840	sub timer {
		841	my ($class, %arg) = @_;
		842
		843	my $cb = $arg{cb};
		844
		845	urxvt::timer
		846	->new
		847	->start (urxvt::NOW + $arg{after})
		848	->cb (sub {
		849	$_[0]->stop; # need to cancel manually
		850	$cb->();
		851	})
		852	}
		853
		854	sub io {
		855	my ($class, %arg) = @_;
		856
		857	my $cb = $arg{cb};
		858
		859	bless [$arg{fh}, urxvt::iow
		860	->new
		861	->fd (fileno $arg{fh})
		862	->events (($arg{poll} =~ /r/ ? 1 : 0)
		863	\| ($arg{poll} =~ /w/ ? 2 : 0))
		864	->start
		865	->cb (sub {
		866	$cb->(($_[1] & 1 ? 'r' : '')
		867	. ($_[1] & 2 ? 'w' : ''));
		868	})],
		869	urxvt::anyevent::
		870	}
		871
		872	sub DESTROY {
		873	$_[0][1]->stop;
		874	}
		875
		876	sub condvar {
		877	bless \my $flag, urxvt::anyevent::condvar::
		878	}
		879
		880	sub urxvt::anyevent::condvar::broadcast {
		881	${$_[0]}++;
		882	}
		883
		884	sub urxvt::anyevent::condvar::wait {
		885	unless (${$_[0]}) {
		886	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		887	}
		888	}
		889
		890	package urxvt::term;
		891
561	=head2 The C<urxvt::term> Class	892	=head2 The C<urxvt::term> Class
562		893
563	=over 4	894	=over 4
564		895
		896	=cut
		897
		898	# find on_xxx subs in the package and register them
		899	# as hooks
		900	sub register_package {
		901	my ($self, $pkg, $argv) = @_;
		902
		903	my $proxy = bless {
		904	_pkg => $pkg,
		905	argv => $argv,
		906	}, $pkg;
		907	Scalar::Util::weaken ($proxy->{term} = $self);
		908
		909	$self->{_pkg}{$pkg} = $proxy;
		910
		911	for my $name (@HOOKNAME) {
		912	if (my $ref = $pkg->can ("on_" . lc $name)) {
		913	$proxy->enable ($name => $ref);
		914	}
		915	}
		916	}
		917
		918	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		919
		920	Creates a new terminal, very similar as if you had started it with system
		921	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		922	hash which defines the environment of the new terminal.
		923
		924	Croaks (and probably outputs an error message) if the new instance
		925	couldn't be created. Returns C<undef> if the new instance didn't
		926	initialise perl, and the terminal object otherwise. The C<init> and
		927	C<start> hooks will be called during this call.
		928
		929	=cut
		930
		931	sub new {
		932	my ($class, $env, @args) = @_;
		933
		934	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		935	}
		936
565	=item $term->destroy	937	=item $term->destroy
566		938
567	Destroy the terminal object (close the window, free resources etc.).	939	Destroy the terminal object (close the window, free resources
		940	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		941	watchers (timers, io watchers) are still active.
		942
		943	=item $isset = $term->option ($optval[, $set])
		944
		945	Returns true if the option specified by C<$optval> is enabled, and
		946	optionally change it. All option values are stored by name in the hash
		947	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		948
		949	Here is a a likely non-exhaustive list of option names, please see the
		950	source file F</src/optinc.h> to see the actual list:
		951
		952	borderLess console cursorBlink cursorUnderline hold iconic insecure
		953	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		954	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		955	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		956	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		957	tripleclickwords utmpInhibit visualBell
568		958
569	=item $value = $term->resource ($name[, $newval])	959	=item $value = $term->resource ($name[, $newval])
570		960
571	Returns the current resource value associated with a given name and	961	Returns the current resource value associated with a given name and
572	optionally sets a new value. Setting values is most useful in the C<init>	962	optionally sets a new value. Setting values is most useful in the C<init>
…		…
582		972
583	Please note that resource strings will currently only be freed when the	973	Please note that resource strings will currently only be freed when the
584	terminal is destroyed, so changing options frequently will eat memory.	974	terminal is destroyed, so changing options frequently will eat memory.
585		975
586	Here is a a likely non-exhaustive list of resource names, not all of which	976	Here is a a likely non-exhaustive list of resource names, not all of which
587	are supported in every build, please see the source to see the actual	977	are supported in every build, please see the source file F</src/rsinc.h>
588	list:	978	to see the actual list:
589		979
590	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	980	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
591	borderLess color cursorBlink cursorUnderline cutchars delete_key	981	borderLess color cursorBlink cursorUnderline cutchars delete_key
592	display_name embed ext_bwidth fade font geometry hold iconName	982	display_name embed ext_bwidth fade font geometry hold iconName
593	imFont imLocale inputMethod insecure int_bwidth intensityStyles	983	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
600	shade term_name title transparent transparent_all tripleclickwords	990	shade term_name title transparent transparent_all tripleclickwords
601	utmpInhibit visualBell	991	utmpInhibit visualBell
602		992
603	=cut	993	=cut
604		994
605	sub urxvt::term::resource($$;$) {	995	sub resource($$;$) {
606	my ($self, $name) = (shift, shift);	996	my ($self, $name) = (shift, shift);
607	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	997	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
608	&urxvt::term::_resource	998	&urxvt::term::_resource
609	}	999	}
610		1000
		1001	=item $value = $term->x_resource ($pattern)
		1002
		1003	Returns the X-Resource for the given pattern, excluding the program or
		1004	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1005	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1006	resource with that pattern exists.
		1007
		1008	This method should only be called during the C<on_start> hook, as there is
		1009	only one resource database per display, and later invocations might return
		1010	the wrong resources.
		1011
		1012	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1013
		1014	Adds a keymap translation exactly as specified via a resource. See the
		1015	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1016
611	=item $rend = $term->rstyle ([$new_rstyle])	1017	=item $rend = $term->rstyle ([$new_rstyle])
612		1018
613	Return and optionally change the current rendition. Text that is output by	1019	Return and optionally change the current rendition. Text that is output by
614	the terminal application will use this style.	1020	the terminal application will use this style.
615		1021
…		…
625	=item ($row, $col) = $term->selection_end ([$row, $col])	1031	=item ($row, $col) = $term->selection_end ([$row, $col])
626		1032
627	Return the current values of the selection mark, begin or end positions,	1033	Return the current values of the selection mark, begin or end positions,
628	and optionally set them to new values.	1034	and optionally set them to new values.
629		1035
		1036	=item $term->selection_make ($eventtime[, $rectangular])
		1037
		1038	Tries to make a selection as set by C<selection_beg> and
		1039	C<selection_end>. If C<$rectangular> is true (default: false), a
		1040	rectangular selection will be made. This is the prefered function to make
		1041	a selection.
		1042
630	=item $success = $term->selection_grab ($eventtime)	1043	=item $success = $term->selection_grab ($eventtime)
631		1044
632	Try to request the primary selection from the server (for example, as set	1045	Try to request the primary selection text from the server (for example, as
633	by the next method).	1046	set by the next method). No visual feedback will be given. This function
		1047	is mostly useful from within C<on_sel_grab> hooks.
634		1048
635	=item $oldtext = $term->selection ([$newtext])	1049	=item $oldtext = $term->selection ([$newtext])
636		1050
637	Return the current selection text and optionally replace it by C<$newtext>.	1051	Return the current selection text and optionally replace it by C<$newtext>.
638		1052
639	#=item $term->overlay ($x, $y, $text)	1053	=item $term->overlay_simple ($x, $y, $text)
640	#	1054
641	#Create a simple multi-line overlay box. See the next method for details.	1055	Create a simple multi-line overlay box. See the next method for details.
642	#	1056
643	#=cut	1057	=cut
644	#	1058
645	#sub urxvt::term::scr_overlay {	1059	sub overlay_simple {
646	# my ($self, $x, $y, $text) = @_;	1060	my ($self, $x, $y, $text) = @_;
647	#	1061
648	# my @lines = split /\n/, $text;	1062	my @lines = split /\n/, $text;
649	#	1063
650	# my $w = 0;	1064	my $w = List::Util::max map $self->strwidth ($_), @lines;
651	# for (map $self->strwidth ($_), @lines) {	1065
652	# $w = $_ if $w < $_;
653	# }
654	#
655	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1066	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
656	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1067	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
657	#}	1068
		1069	$overlay
		1070	}
658		1071
659	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1072	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
660		1073
661	Create a new (empty) overlay at the given position with the given	1074	Create a new (empty) overlay at the given position with the given
662	width/height. C<$rstyle> defines the initial rendition style	1075	width/height. C<$rstyle> defines the initial rendition style
…		…
697	C<$event> I<must> be the event causing the menu to pop up (a button event,	1110	C<$event> I<must> be the event causing the menu to pop up (a button event,
698	currently).	1111	currently).
699		1112
700	=cut	1113	=cut
701		1114
702	sub urxvt::term::popup {	1115	sub popup {
703	my ($self, $event) = @_;	1116	my ($self, $event) = @_;
704		1117
705	$self->grab ($event->{time}, 1)	1118	$self->grab ($event->{time}, 1)
706	or return;	1119	or return;
707		1120
…		…
729		1142
730	=item $string = $term->locale_decode ($octets)	1143	=item $string = $term->locale_decode ($octets)
731		1144
732	Convert the given locale-encoded octets into a perl string.	1145	Convert the given locale-encoded octets into a perl string.
733		1146
		1147	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1148
		1149	XORs the rendition values in the given span with the provided value
		1150	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1151	refresh hooks to provide effects similar to the selection.
		1152
		1153	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1154
		1155	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1156	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1157	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1158	it instead. Both styles I<MUST NOT> contain font styles.
		1159
		1160	=item $term->scr_bell
		1161
		1162	Ring the bell!
		1163
734	=item $term->scr_add_lines ($string)	1164	=item $term->scr_add_lines ($string)
735		1165
736	Write the given text string to the screen, as if output by the application	1166	Write the given text string to the screen, as if output by the application
737	running inside the terminal. It may not contain command sequences (escape	1167	running inside the terminal. It may not contain command sequences (escape
738	codes), but is free to use line feeds, carriage returns and tabs. The	1168	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
752		1182
753	Write the octets given in C<$data> to the tty (i.e. as program input). To	1183	Write the octets given in C<$data> to the tty (i.e. as program input). To
754	pass characters instead of octets, you should convert your strings first	1184	pass characters instead of octets, you should convert your strings first
755	to the locale-specific encoding using C<< $term->locale_encode >>.	1185	to the locale-specific encoding using C<< $term->locale_encode >>.
756		1186
		1187	=item $old_events = $term->pty_ev_events ([$new_events])
		1188
		1189	Replaces the event mask of the pty watcher by the given event mask. Can
		1190	be used to suppress input and output handling to the pty/tty. See the
		1191	description of C<< urxvt::timer->events >>. Make sure to always restore
		1192	the previous value.
		1193
757	=item $windowid = $term->parent	1194	=item $windowid = $term->parent
758		1195
759	Return the window id of the toplevel window.	1196	Return the window id of the toplevel window.
760		1197
761	=item $windowid = $term->vt	1198	=item $windowid = $term->vt
762		1199
763	Return the window id of the terminal window.	1200	Return the window id of the terminal window.
764		1201
		1202	=item $term->vt_emask_add ($x_event_mask)
		1203
		1204	Adds the specified events to the vt event mask. Useful e.g. when you want
		1205	to receive pointer events all the times:
		1206
		1207	$term->vt_emask_add (urxvt::PointerMotionMask);
		1208
765	=item $window_width = $term->width	1209	=item $window_width = $term->width
766		1210
767	=item $window_height = $term->height	1211	=item $window_height = $term->height
768		1212
769	=item $font_width = $term->fwidth	1213	=item $font_width = $term->fwidth
…		…
782		1226
783	=item $max_scrollback = $term->saveLines	1227	=item $max_scrollback = $term->saveLines
784		1228
785	=item $nrow_plus_saveLines = $term->total_rows	1229	=item $nrow_plus_saveLines = $term->total_rows
786		1230
787	=item $lines_in_scrollback = $term->nsaved	1231	=item $topmost_scrollback_row = $term->top_row
788		1232
789	Return various integers describing terminal characteristics.	1233	Return various integers describing terminal characteristics.
		1234
		1235	=item $x_display = $term->display_id
		1236
		1237	Return the DISPLAY used by rxvt-unicode.
		1238
		1239	=item $lc_ctype = $term->locale
		1240
		1241	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1242
		1243	=item $env = $term->env
		1244
		1245	Returns a copy of the environment in effect for the terminal as a hashref
		1246	similar to C<\%ENV>.
		1247
		1248	=cut
		1249
		1250	sub env {
		1251	if (my $env = $_[0]->_env) {
		1252	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1253	} else {
		1254	+{ %ENV }
		1255	}
		1256	}
790		1257
791	=item $modifiermask = $term->ModLevel3Mask	1258	=item $modifiermask = $term->ModLevel3Mask
792		1259
793	=item $modifiermask = $term->ModMetaMask	1260	=item $modifiermask = $term->ModMetaMask
794		1261
…		…
797	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1264	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
798	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1265	AltGr), the meta key (often Alt) and the num lock key, if applicable.
799		1266
800	=item $view_start = $term->view_start ([$newvalue])	1267	=item $view_start = $term->view_start ([$newvalue])
801		1268
802	Returns the negative row number of the topmost line. Minimum value is	1269	Returns the row number of the topmost displayed line. Maximum value is
803	C<0>, which displays the normal terminal contents. Larger values scroll	1270	C<0>, which displays the normal terminal contents. Lower values scroll
804	this many lines into the scrollback buffer.	1271	this many lines into the scrollback buffer.
805		1272
806	=item $term->want_refresh	1273	=item $term->want_refresh
807		1274
808	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1275	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
887	Return the row number of the first/last row of the line, respectively.	1354	Return the row number of the first/last row of the line, respectively.
888		1355
889	=item $offset = $line->offset_of ($row, $col)	1356	=item $offset = $line->offset_of ($row, $col)
890		1357
891	Returns the character offset of the given row\|col pair within the logical	1358	Returns the character offset of the given row\|col pair within the logical
892	line.	1359	line. Works for rows outside the line, too, and returns corresponding
		1360	offsets outside the string.
893		1361
894	=item ($row, $col) = $line->coord_of ($offset)	1362	=item ($row, $col) = $line->coord_of ($offset)
895		1363
896	Translates a string offset into terminal coordinates again.	1364	Translates a string offset into terminal coordinates again.
897		1365
898	=back	1366	=back
899		1367
900	=cut	1368	=cut
901		1369
902	sub urxvt::term::line {	1370	sub line {
903	my ($self, $row) = @_;	1371	my ($self, $row) = @_;
904		1372
905	my $maxrow = $self->nrow - 1;	1373	my $maxrow = $self->nrow - 1;
906		1374
907	my ($beg, $end) = ($row, $row);	1375	my ($beg, $end) = ($row, $row);
…		…
971	$offset / $self->{ncol} + $self->{beg},	1439	$offset / $self->{ncol} + $self->{beg},
972	$offset % $self->{ncol}	1440	$offset % $self->{ncol}
973	)	1441	)
974	}	1442	}
975		1443
976	=item ($row, $col) = $line->coord_of ($offset)
977	=item $text = $term->special_encode $string	1444	=item $text = $term->special_encode $string
978		1445
979	Converts a perl string into the special encoding used by rxvt-unicode,	1446	Converts a perl string into the special encoding used by rxvt-unicode,
980	where one character corresponds to one screen cell. See	1447	where one character corresponds to one screen cell. See
981	C<< $term->ROW_t >> for details.	1448	C<< $term->ROW_t >> for details.
…		…
983	=item $string = $term->special_decode $text	1450	=item $string = $term->special_decode $text
984		1451
985	Converts rxvt-unicodes text reprsentation into a perl string. See	1452	Converts rxvt-unicodes text reprsentation into a perl string. See
986	C<< $term->ROW_t >> for details.	1453	C<< $term->ROW_t >> for details.
987		1454
		1455	=item $success = $term->grab_button ($button, $modifiermask)
		1456
		1457	Registers a synchronous button grab. See the XGrabButton manpage.
		1458
		1459	=item $success = $term->grab ($eventtime[, $sync])
		1460
		1461	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1462	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1463
		1464	=item $term->allow_events_async
		1465
		1466	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1467
		1468	=item $term->allow_events_sync
		1469
		1470	Calls XAllowEvents with SyncBoth for the most recent grab.
		1471
		1472	=item $term->allow_events_replay
		1473
		1474	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1475	recent grab.
		1476
		1477	=item $term->ungrab
		1478
		1479	Calls XUngrab for the most recent grab. Is called automatically on
		1480	evaluation errors, as it is better to lose the grab in the error case as
		1481	the session.
		1482
988	=back	1483	=back
989		1484
		1485	=cut
		1486
		1487	package urxvt::popup;
		1488
990	=head2 The C<urxvt::popup> Class	1489	=head2 The C<urxvt::popup> Class
991		1490
992	=over 4	1491	=over 4
993		1492
994	=cut	1493	=cut
995
996	package urxvt::popup;
997		1494
998	sub add_item {	1495	sub add_item {
999	my ($self, $item) = @_;	1496	my ($self, $item) = @_;
1000		1497
		1498	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1499	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1500	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1501
		1502	$item->{render} \|\|= sub { $_[0]{text} };
		1503
1001	push @{ $self->{item} }, $item;	1504	push @{ $self->{item} }, $item;
1002	}	1505	}
		1506
		1507	=item $popup->add_title ($title)
		1508
		1509	Adds a non-clickable title to the popup.
		1510
		1511	=cut
		1512
		1513	sub add_title {
		1514	my ($self, $title) = @_;
		1515
		1516	$self->add_item ({
		1517	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1518	text => $title,
		1519	activate => sub { },
		1520	});
		1521	}
		1522
		1523	=item $popup->add_separator ([$sepchr])
		1524
		1525	Creates a separator, optionally using the character given as C<$sepchr>.
		1526
		1527	=cut
		1528
		1529	sub add_separator {
		1530	my ($self, $sep) = @_;
		1531
		1532	$sep \|\|= "=";
		1533
		1534	$self->add_item ({
		1535	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1536	text => "",
		1537	render => sub { $sep x $self->{term}->ncol },
		1538	activate => sub { },
		1539	});
		1540	}
		1541
		1542	=item $popup->add_button ($text, $cb)
		1543
		1544	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1545	selected.
		1546
		1547	=cut
1003		1548
1004	sub add_button {	1549	sub add_button {
1005	my ($self, $text, $cb) = @_;	1550	my ($self, $text, $cb) = @_;
1006		1551
1007	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,	1552	$self->add_item ({ type => "button", text => $text, activate => $cb});
1008	render => sub { $_[0]{text} },
1009	});
1010	}	1553	}
		1554
		1555	=item $popup->add_toggle ($text, $cb, $initial_value)
		1556
		1557	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1558	whenever it gets toggled, with a boolean indicating its value as its first
		1559	argument.
		1560
		1561	=cut
1011		1562
1012	sub add_toggle {	1563	sub add_toggle {
1013	my ($self, $text, $cb, $value) = @_;	1564	my ($self, $text, $cb, $value) = @_;
1014		1565
1015	$self->add_item ({ type => "button", text => " $text", value => $value,	1566	my $item; $item = {
		1567	type => "button",
		1568	text => " $text",
		1569	value => $value,
1016	render => sub { ($_[0]{value} ? "✔" : " ") . substr $_[0]{text}, 1 },	1570	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1017	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1571	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1018	});	1572	};
		1573
		1574	$self->add_item ($item);
1019	}	1575	}
		1576
		1577	=item $popup->show
		1578
		1579	Displays the popup (which is initially hidden).
		1580
		1581	=cut
1020		1582
1021	sub show {	1583	sub show {
1022	my ($self) = @_;	1584	my ($self) = @_;
1023		1585
1024	local $urxvt::popup::self = $self;	1586	local $urxvt::popup::self = $self;
1025		1587
		1588	my $env = $self->{term}->env;
		1589	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1590	delete $env->{LC_ALL};
		1591	$env->{LC_CTYPE} = $self->{term}->locale;
		1592
		1593	urxvt::term->new ($env, $self->{term}->resource ("name"),
1026	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1594	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1027	"--transient-for" => $self->{term}->parent,	1595	"--transient-for" => $self->{term}->parent,
		1596	"-display" => $self->{term}->display_id,
1028	"-pe" => "urxvt-popup")	1597	"-pe" => "urxvt-popup")
1029	or die "unable to create popup window\n";	1598	or die "unable to create popup window\n";
1030	}	1599	}
1031		1600
1032	sub DESTROY {	1601	sub DESTROY {
1033	my ($self) = @_;	1602	my ($self) = @_;
1034		1603
		1604	delete $self->{term}{_destroy}{$self};
1035	$self->{term}->ungrab;	1605	$self->{term}->ungrab;
1036	}	1606	}
		1607
		1608	=back
1037		1609
1038	=head2 The C<urxvt::timer> Class	1610	=head2 The C<urxvt::timer> Class
1039		1611
1040	This class implements timer watchers/events. Time is represented as a	1612	This class implements timer watchers/events. Time is represented as a
1041	fractional number of seconds since the epoch. Example:	1613	fractional number of seconds since the epoch. Example:
…		…
1094		1666
1095	$term->{socket} = ...	1667	$term->{socket} = ...
1096	$term->{iow} = urxvt::iow	1668	$term->{iow} = urxvt::iow
1097	->new	1669	->new
1098	->fd (fileno $term->{socket})	1670	->fd (fileno $term->{socket})
1099	->events (1) # wait for read data	1671	->events (urxvt::EVENT_READ)
1100	->start	1672	->start
1101	->cb (sub {	1673	->cb (sub {
1102	my ($iow, $revents) = @_;	1674	my ($iow, $revents) = @_;
1103	# $revents must be 1 here, no need to check	1675	# $revents must be 1 here, no need to check
1104	sysread $term->{socket}, my $buf, 8192	1676	sysread $term->{socket}, my $buf, 8192
…		…
1121		1693
1122	Set the filedescriptor (not handle) to watch.	1694	Set the filedescriptor (not handle) to watch.
1123		1695
1124	=item $iow = $iow->events ($eventmask)	1696	=item $iow = $iow->events ($eventmask)
1125		1697
1126	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1698	Set the event mask to watch. The only allowed values are
1127	data, Bit #1 (value C<2>) enables watching for write data.	1699	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1700	together, or C<urxvt::EVENT_NONE>.
1128		1701
1129	=item $iow = $iow->start	1702	=item $iow = $iow->start
1130		1703
1131	Start watching for requested events on the given handle.	1704	Start watching for requested events on the given handle.
1132		1705
…		…
1143	This variable controls the verbosity level of the perl extension. Higher	1716	This variable controls the verbosity level of the perl extension. Higher
1144	numbers indicate more verbose output.	1717	numbers indicate more verbose output.
1145		1718
1146	=over 4	1719	=over 4
1147		1720
1148	=item =0 - only fatal messages	1721	=item == 0 - fatal messages
1149		1722
1150	=item =3 - script loading and management	1723	=item >= 3 - script loading and management
1151		1724
1152	=item =10 - all events received	1725	=item >=10 - all called hooks
		1726
		1727	=item >=11 - hook reutrn values
1153		1728
1154	=back	1729	=back
1155		1730
1156	=head1 AUTHOR	1731	=head1 AUTHOR
1157		1732

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC vs. Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC vs.
Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC