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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.58 by root, Sun Jan 8 22:58:13 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 (enabled by default)	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
…		…
58		80
59	=back	81	=back
60		82
61	=item option-popup (enabled by default)	83	=item option-popup (enabled by default)
62		84
63	Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at	85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	86	runtime.
65		87
66	=item digital-clock	88	=item selection-popup (enabled by default)
67		89
68	Displays a digital clock using the built-in overlay.	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.
69		161
70	=item mark-urls	162	=item mark-urls
71		163
72	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.
73		168
74	=item block-graphics-to-ascii	169	=item block-graphics-to-ascii
75		170
76	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,
77	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
78	similar-looking ascii character.	173	similar-looking ascii character.
79		174
		175	=item digital-clock
		176
		177	Displays a digital clock using the built-in overlay.
		178
80	=item example-refresh-hooks	179	=item example-refresh-hooks
81		180
82	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
83	window. Illustrates overwriting the refresh callbacks to create your own	182	window. Illustrates overwriting the refresh callbacks to create your own
84	overlays or changes.	183	overlays or changes.
85		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
86	=back	214	=back
		215
		216	=head1 API DOCUMENTATION
87		217
88	=head2 General API Considerations	218	=head2 General API Considerations
89		219
90	All objects (such as terminals, time watchers etc.) are typical	220	All objects (such as terminals, time watchers etc.) are typical
91	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
…		…
104	=over 4	234	=over 4
105		235
106	=item $text	236	=item $text
107		237
108	Rxvt-unicodes special way of encoding text, where one "unicode" character	238	Rxvt-unicodes special way of encoding text, where one "unicode" character
109	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.
110		240
111	=item $string	241	=item $string
112		242
113	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
114	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
…		…
119	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
120	locale-specific way.	250	locale-specific way.
121		251
122	=back	252	=back
123		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
124	=head2 Hooks	287	=head2 Hooks
125		288
126	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
127	called whenever the relevant event happens.	290	called whenever the relevant event happens.
128		291
129	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
130	and extension package. You can call all C<urxvt::term> methods on it, but	293	the in the C<Extension Objects> section.
131	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132	object that is shared between all packages is stored in the C<term>
133	member. It is, however, blessed intot he package of the extension script,
134	so for all practical purposes you can treat an extension script as a class.
135		294
136	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
137	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
138	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.
139		298
140	When in doubt, return a false value (preferably C<()>).	299	I<< When in doubt, return a false value (preferably C<()>). >>
141		300
142	=over 4	301	=over 4
143		302
144	=item on_init $term	303	=item on_init $term
145		304
…		…
180	=item on_sel_extend $term	339	=item on_sel_extend $term
181		340
182	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
183	click) and is either supposed to return false (normal operation), or	342	click) and is either supposed to return false (normal operation), or
184	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
185	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.
186		347
187	See the F<selection> example extension.	348	See the F<selection> example extension.
188		349
189	=item on_view_change $term, $offset	350	=item on_view_change $term, $offset
190		351
…		…
199	than the scroll back buffer or the terminal.	360	than the scroll back buffer or the terminal.
200		361
201	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,
202	$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
203	number of lines that will be in the scrollback buffer.	364	number of lines that will be in the scrollback buffer.
204
205	=item on_tty_activity $term NYI
206
207	Called whenever the program(s) running in the urxvt window send output.
208		365
209	=item on_osc_seq $term, $string	366	=item on_osc_seq $term, $string
210		367
211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	368	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212	operating system command) is processed. Cursor position and other state	369	operating system command) is processed. Cursor position and other state
…		…
225	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
226	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
227	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
228	output.	385	output.
229		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
230	=item on_line_update $term, $row	392	=item on_line_update $term, $row
231		393
232	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
233	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
234	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,
…		…
256		418
257	Called whenever the user presses a key combination that has a	419	Called whenever the user presses a key combination that has a
258	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>
259	resource in the @@RXVT_NAME@@(1) manpage).	421	resource in the @@RXVT_NAME@@(1) manpage).
260		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
261	=item on_focus_in $term	429	=item on_focus_in $term
262		430
263	Called whenever the window gets the keyboard focus, before rxvt-unicode	431	Called whenever the window gets the keyboard focus, before rxvt-unicode
264	does focus in processing.	432	does focus in processing.
265		433
266	=item on_focus_out $term	434	=item on_focus_out $term
267		435
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	436	Called wheneever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	437	focus out processing.
270		438
271	=item on_key_press $term, $event, $octets	439	=item on_key_press $term, $event, $keysym, $octets
272		440
273	=item on_key_release $term, $event	441	=item on_key_release $term, $event, $keysym
274		442
275	=item on_button_press $term, $event	443	=item on_button_press $term, $event
276		444
277	=item on_button_release $term, $event	445	=item on_button_release $term, $event
278		446
…		…
294		462
295	subwindow.	463	subwindow.
296		464
297	=back	465	=back
298		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
299	=head2 Variables in the C<urxvt> Package	488	=head2 Variables in the C<urxvt> Package
300		489
301	=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>.
302		504
303	=item $urxvt::TERM	505	=item $urxvt::TERM
304		506
305	The current terminal. This variable stores the current C<urxvt::term>	507	The current terminal. This variable stores the current C<urxvt::term>
306	object, whenever a callback/hook is executing.	508	object, whenever a callback/hook is executing.
…		…
308	=back	510	=back
309		511
310	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
311		513
312	=over 4	514	=over 4
313
314	=item $term = new urxvt [arg...]
315
316	Creates a new terminal, very similar as if you had started it with
317	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
318	if the new instance couldn't be created. Returns C<undef> if the new
319	instance didn't initialise perl, and the terminal object otherwise. The
320	C<init> and C<start> hooks will be called during the call.
321		515
322	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
323		517
324	Fatally aborts execution with the given error message. Avoid at all	518	Fatally aborts execution with the given error message. Avoid at all
325	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
…		…
332	that calls this function.	526	that calls this function.
333		527
334	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
335	correct place, e.g. on stderr of the connecting urxvtc client.	529	correct place, e.g. on stderr of the connecting urxvtc client.
336		530
		531	Messages have a size limit of 1023 bytes currently.
		532
337	=item $time = urxvt::NOW	533	=item $time = urxvt::NOW
338		534
339	Returns the "current time" (as per the event loop).	535	Returns the "current time" (as per the event loop).
340		536
341	=item urxvt::CurrentTime	537	=item urxvt::CurrentTime
342		538
343	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	539	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	540	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345	Button4Mask, Button5Mask, AnyModifier	541	Button4Mask, Button5Mask, AnyModifier
		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
346		558
347	Various constants for use in X calls and event processing.	559	Various constants for use in X calls and event processing.
348		560
349	=back	561	=back
350		562
…		…
379		591
380	=item $background = urxvt::GET_BASEBG $rend	592	=item $background = urxvt::GET_BASEBG $rend
381		593
382	Return the foreground/background colour index, respectively.	594	Return the foreground/background colour index, respectively.
383		595
384	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	596	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385		597
386	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	598	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
387		599
388	Replace the foreground/background colour in the rendition mask with the	600	Replace the foreground/background colour in the rendition mask with the
389	specified one.	601	specified one.
390		602
391	=item $value = urxvt::GET_CUSTOM ($rend)	603	=item $value = urxvt::GET_CUSTOM $rend
392		604
393	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
394	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
395	zero.	607	zero.
396		608
397	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	609	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398		610
399	Change the custom value.	611	Change the custom value.
400		612
401	=back	613	=back
402		614
403	=cut	615	=cut
404		616
405	package urxvt;
406
407	use utf8;
408	use strict;
409	use Scalar::Util ();
410	use List::Util ();
411
412	our $VERSION = 1;
413	our $TERM;
414	our @HOOKNAME;
415	our %OPTION;
416	our $LIBDIR;
417
418	BEGIN {	617	BEGIN {
419	urxvt->bootstrap;
420
421	# overwrite perl's warn	618	# overwrite perl's warn
422	*CORE::GLOBAL::warn = sub {	619	*CORE::GLOBAL::warn = sub {
423	my $msg = join "", @_;	620	my $msg = join "", @_;
424	$msg .= "\n"	621	$msg .= "\n"
425	unless $msg =~ /\n$/;	622	unless $msg =~ /\n$/;
426	urxvt::warn ($msg);	623	urxvt::warn ($msg);
427	};	624	};
428	}
429		625
430	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
431	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	633	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
432		634
433	sub verbose {	635	sub verbose {
434	my ($level, $msg) = @_;	636	my ($level, $msg) = @_;
435	warn "$msg\n" if $level <= $verbosity;	637	warn "$msg\n" if $level <= $verbosity;
436	}	638	}
437		639
438	# find on_xxx subs in the package and register them
439	# as hooks
440	sub register_package($) {
441	my ($pkg) = @_;
442
443	for my $htype (0.. $#HOOKNAME) {
444	my $name = $HOOKNAME[$htype];
445
446	my $ref = $pkg->can ("on_" . lc $name)
447	or next;
448
449	$TERM->{_hook}[$htype]{$pkg} = $ref;
450	$hook_count[$htype]++
451	or set_should_invoke $htype, 1;
452	}
453	}
454
455	my $extension_pkg = "extension0000";
456	my %extension_pkg;	640	my %extension_pkg;
457		641
458	# load a single script into its own package, once only	642	# load a single script into its own package, once only
459	sub extension_package($) {	643	sub extension_package($) {
460	my ($path) = @_;	644	my ($path) = @_;
461		645
		646	no strict 'refs';
		647
462	$extension_pkg{$path} \|\|= do {	648	$extension_pkg{$path} \|\|= do {
463	my $pkg = "urxvt::" . ($extension_pkg++);	649	$path =~ /([^\/\\]+)$/;
		650	my $pkg = $1;
		651	$pkg =~ s/[^[:word:]]/_/g;
		652	$pkg = "urxvt::ext::$pkg";
464		653
465	verbose 3, "loading extension '$path' into package '$pkg'";	654	verbose 3, "loading extension '$path' into package '$pkg'";
466		655
467	open my $fh, "<:raw", $path	656	open my $fh, "<:raw", $path
468	or die "$path: $!";	657	or die "$path: $!";
469		658
		659	@{"$pkg\::ISA"} = urxvt::term::extension::;
		660
		661	my $source =
470	my $source = "package $pkg; use strict; use utf8;\n"	662	"package $pkg; use strict; use utf8;\n"
471	. "use base urxvt::term::proxy::;\n"
472	. "#line 1 \"$path\"\n{\n"	663	. "#line 1 \"$path\"\n{\n"
473	. (do { local $/; <$fh> })	664	. (do { local $/; <$fh> })
474	. "\n};\n1";	665	. "\n};\n1";
475		666
476	$source =~ /(.*)/s and $source = $1; # untaint	667	eval $source
477
478	eval $source or die "$path: $@";	668	or die "$path: $@";
479		669
480	$pkg	670	$pkg
481	}	671	}
482	}	672	}
483		673
…		…
489	my $htype = shift;	679	my $htype = shift;
490		680
491	if ($htype == 0) { # INIT	681	if ($htype == 0) { # INIT
492	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	682	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
493		683
494	my %want_ext;	684	my %ext_arg;
495		685
496	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	686	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
497	if ($_ eq "default") {	687	if ($_ eq "default") {
498	$want_ext{$_}++ for qw(selection option-popup);	688	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
499	} elsif (/^-(.*)$/) {	689	} elsif (/^-(.*)$/) {
500	delete $want_ext{$1};	690	delete $ext_arg{$1};
		691	} elsif (/^([^<]+)<(.*)>$/) {
		692	push @{ $ext_arg{$1} }, $2;
501	} else {	693	} else {
502	$want_ext{$_}++;	694	$ext_arg{$_} \|\|= [];
503	}	695	}
504	}	696	}
505		697
506	for my $ext (keys %want_ext) {	698	while (my ($ext, $argv) = each %ext_arg) {
507	my @files = grep -f $_, map "$_/$ext", @dirs;	699	my @files = grep -f $_, map "$_/$ext", @dirs;
508		700
509	if (@files) {	701	if (@files) {
510	register_package extension_package $files[0];	702	$TERM->register_package (extension_package $files[0], $argv);
511	} else {	703	} else {
512	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";
513	}	705	}
514	}	706	}
515		707
…		…
524	if $verbosity >= 10;	716	if $verbosity >= 10;
525		717
526	keys %$cb;	718	keys %$cb;
527		719
528	while (my ($pkg, $cb) = each %$cb) {	720	while (my ($pkg, $cb) = each %$cb) {
529	eval {	721	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
530	$retval = $cb->(
531	$TERM->{_pkg}{$pkg} \|\|= do {
532	my $proxy = bless { }, $pkg;
533	Scalar::Util::weaken ($proxy->{term} = $TERM);
534	$proxy
535	},
536	@_,
537	) and last;	722	and last;
538	};	723
539	if ($@) {	724	if ($@) {
540	$TERM->ungrab; # better to lose the grab than the session	725	$TERM->ungrab; # better to lose the grab than the session
541	warn $@;	726	warn $@;
542	}	727	}
543	}	728	}
		729
		730	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		731	if $verbosity >= 11;
544	}	732	}
545		733
546	if ($htype == 1) { # DESTROY	734	if ($htype == 1) { # DESTROY
547	# remove hooks if unused
548	if (my $hook = $TERM->{_hook}) {
549	for my $htype (0..$#$hook) {
550	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
551	or set_should_invoke $htype, 0;
552	}
553	}
554
555	# clear package objects	735	# clear package objects
556	%$_ = () for values %{ $TERM->{_pkg} };	736	%$_ = () for values %{ $TERM->{_pkg} };
557		737
558	# clear package	738	# clear package
559	%$TERM = ();	739	%$TERM = ();
560	}	740	}
561		741
562	$retval	742	$retval
563	}	743	}
564		744
565	# urxvt::term::proxy	745	sub exec_async(@) {
		746	my $pid = fork;
566		747
567	sub urxvt::term::proxy::AUTOLOAD {	748	return
568	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	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 =~ /:([^:]+)$/
569	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	795	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
570		796
571	eval qq{	797	eval qq{
572	sub $urxvt::term::proxy::AUTOLOAD {	798	sub $AUTOLOAD {
573	my \$proxy = shift;	799	my \$proxy = shift;
574	\$proxy->{term}->$1 (\@_)	800	\$proxy->{term}->$1 (\@_)
575	}	801	}
576	1	802	1
577	} or die "FATAL: unable to compile method forwarder: $@";	803	} or die "FATAL: unable to compile method forwarder: $@";
578		804
579	goto &$urxvt::term::proxy::AUTOLOAD;	805	goto &$AUTOLOAD;
580	}	806	}
581		807
582	sub urxvt::term::proxy::DESTROY {	808	sub DESTROY {
583	# nop	809	# nop
584	}	810	}
585		811
586	# urxvt::destroy_hook	812	# urxvt::destroy_hook
587		813
…		…
597		823
598	=head2 The C<urxvt::anyevent> Class	824	=head2 The C<urxvt::anyevent> Class
599		825
600	The sole purpose of this class is to deliver an interface to the	826	The sole purpose of this class is to deliver an interface to the
601	C<AnyEvent> module - any module using it will work inside urxvt without	827	C<AnyEvent> module - any module using it will work inside urxvt without
602	further work. The only exception is that you cannot wait on condition	828	further programming. The only exception is that you cannot wait on
603	variables, but non-blocking condvar use is ok. What this means is that you	829	condition variables, but non-blocking condvar use is ok. What this means
604	cannot use blocking APIs, but the non-blocking variant should work.	830	is that you cannot use blocking APIs, but the non-blocking variant should
		831	work.
605		832
606	=cut	833	=cut
607		834
608	our $VERSION = 1;	835	our $VERSION = 1;
609		836
…		…
654	${$_[0]}++;	881	${$_[0]}++;
655	}	882	}
656		883
657	sub urxvt::anyevent::condvar::wait {	884	sub urxvt::anyevent::condvar::wait {
658	unless (${$_[0]}) {	885	unless (${$_[0]}) {
659	require Carp;
660	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	886	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
661	}	887	}
662	}	888	}
663		889
664	package urxvt::term;	890	package urxvt::term;
665		891
666	=head2 The C<urxvt::term> Class	892	=head2 The C<urxvt::term> Class
667		893
668	=over 4	894	=over 4
669		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
670	=item $term->destroy	937	=item $term->destroy
671		938
672	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.
673		942
674	=item $isset = $term->option ($optval[, $set])	943	=item $isset = $term->option ($optval[, $set])
675		944
676	Returns true if the option specified by C<$optval> is enabled, and	945	Returns true if the option specified by C<$optval> is enabled, and
677	optionally change it. All option values are stored by name in the hash	946	optionally change it. All option values are stored by name in the hash
…		…
727	my ($self, $name) = (shift, shift);	996	my ($self, $name) = (shift, shift);
728	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	997	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
729	&urxvt::term::_resource	998	&urxvt::term::_resource
730	}	999	}
731		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
732	=item $rend = $term->rstyle ([$new_rstyle])	1017	=item $rend = $term->rstyle ([$new_rstyle])
733		1018
734	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
735	the terminal application will use this style.	1020	the terminal application will use this style.
736		1021
…		…
746	=item ($row, $col) = $term->selection_end ([$row, $col])	1031	=item ($row, $col) = $term->selection_end ([$row, $col])
747		1032
748	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,
749	and optionally set them to new values.	1034	and optionally set them to new values.
750		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
751	=item $success = $term->selection_grab ($eventtime)	1043	=item $success = $term->selection_grab ($eventtime)
752		1044
753	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
754	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.
755		1048
756	=item $oldtext = $term->selection ([$newtext])	1049	=item $oldtext = $term->selection ([$newtext])
757		1050
758	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>.
759		1052
760	#=item $term->overlay ($x, $y, $text)	1053	=item $term->overlay_simple ($x, $y, $text)
761	#	1054
762	#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.
763	#	1056
764	#=cut	1057	=cut
765	#	1058
766	#sub urxvt::term::scr_overlay {	1059	sub overlay_simple {
767	# my ($self, $x, $y, $text) = @_;	1060	my ($self, $x, $y, $text) = @_;
768	#	1061
769	# my @lines = split /\n/, $text;	1062	my @lines = split /\n/, $text;
770	#	1063
771	# my $w = 0;	1064	my $w = List::Util::max map $self->strwidth ($_), @lines;
772	# for (map $self->strwidth ($_), @lines) {	1065
773	# $w = $_ if $w < $_;
774	# }
775	#
776	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1066	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
777	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1067	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
778	#}	1068
		1069	$overlay
		1070	}
779		1071
780	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1072	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
781		1073
782	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
783	width/height. C<$rstyle> defines the initial rendition style	1075	width/height. C<$rstyle> defines the initial rendition style
…		…
850		1142
851	=item $string = $term->locale_decode ($octets)	1143	=item $string = $term->locale_decode ($octets)
852		1144
853	Convert the given locale-encoded octets into a perl string.	1145	Convert the given locale-encoded octets into a perl string.
854		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
855	=item $term->scr_add_lines ($string)	1164	=item $term->scr_add_lines ($string)
856		1165
857	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
858	running inside the terminal. It may not contain command sequences (escape	1167	running inside the terminal. It may not contain command sequences (escape
859	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
…		…
873		1182
874	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
875	pass characters instead of octets, you should convert your strings first	1184	pass characters instead of octets, you should convert your strings first
876	to the locale-specific encoding using C<< $term->locale_encode >>.	1185	to the locale-specific encoding using C<< $term->locale_encode >>.
877		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
878	=item $windowid = $term->parent	1194	=item $windowid = $term->parent
879		1195
880	Return the window id of the toplevel window.	1196	Return the window id of the toplevel window.
881		1197
882	=item $windowid = $term->vt	1198	=item $windowid = $term->vt
883		1199
884	Return the window id of the terminal window.	1200	Return the window id of the terminal window.
885		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
886	=item $window_width = $term->width	1209	=item $window_width = $term->width
887		1210
888	=item $window_height = $term->height	1211	=item $window_height = $term->height
889		1212
890	=item $font_width = $term->fwidth	1213	=item $font_width = $term->fwidth
…		…
903		1226
904	=item $max_scrollback = $term->saveLines	1227	=item $max_scrollback = $term->saveLines
905		1228
906	=item $nrow_plus_saveLines = $term->total_rows	1229	=item $nrow_plus_saveLines = $term->total_rows
907		1230
908	=item $lines_in_scrollback = $term->nsaved	1231	=item $topmost_scrollback_row = $term->top_row
909		1232
910	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	}
911		1257
912	=item $modifiermask = $term->ModLevel3Mask	1258	=item $modifiermask = $term->ModLevel3Mask
913		1259
914	=item $modifiermask = $term->ModMetaMask	1260	=item $modifiermask = $term->ModMetaMask
915		1261
…		…
918	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
919	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.
920		1266
921	=item $view_start = $term->view_start ([$newvalue])	1267	=item $view_start = $term->view_start ([$newvalue])
922		1268
923	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
924	C<0>, which displays the normal terminal contents. Larger values scroll	1270	C<0>, which displays the normal terminal contents. Lower values scroll
925	this many lines into the scrollback buffer.	1271	this many lines into the scrollback buffer.
926		1272
927	=item $term->want_refresh	1273	=item $term->want_refresh
928		1274
929	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1275	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1008	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.
1009		1355
1010	=item $offset = $line->offset_of ($row, $col)	1356	=item $offset = $line->offset_of ($row, $col)
1011		1357
1012	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
1013	line.	1359	line. Works for rows outside the line, too, and returns corresponding
		1360	offsets outside the string.
1014		1361
1015	=item ($row, $col) = $line->coord_of ($offset)	1362	=item ($row, $col) = $line->coord_of ($offset)
1016		1363
1017	Translates a string offset into terminal coordinates again.	1364	Translates a string offset into terminal coordinates again.
1018		1365
…		…
1092	$offset / $self->{ncol} + $self->{beg},	1439	$offset / $self->{ncol} + $self->{beg},
1093	$offset % $self->{ncol}	1440	$offset % $self->{ncol}
1094	)	1441	)
1095	}	1442	}
1096		1443
1097	=item ($row, $col) = $line->coord_of ($offset)
1098	=item $text = $term->special_encode $string	1444	=item $text = $term->special_encode $string
1099		1445
1100	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,
1101	where one character corresponds to one screen cell. See	1447	where one character corresponds to one screen cell. See
1102	C<< $term->ROW_t >> for details.	1448	C<< $term->ROW_t >> for details.
…		…
1104	=item $string = $term->special_decode $text	1450	=item $string = $term->special_decode $text
1105		1451
1106	Converts rxvt-unicodes text reprsentation into a perl string. See	1452	Converts rxvt-unicodes text reprsentation into a perl string. See
1107	C<< $term->ROW_t >> for details.	1453	C<< $term->ROW_t >> for details.
1108		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
1109	=back	1483	=back
1110		1484
1111	=cut	1485	=cut
1112		1486
1113	package urxvt::popup;	1487	package urxvt::popup;
…		…
1128	$item->{render} \|\|= sub { $_[0]{text} };	1502	$item->{render} \|\|= sub { $_[0]{text} };
1129		1503
1130	push @{ $self->{item} }, $item;	1504	push @{ $self->{item} }, $item;
1131	}	1505	}
1132		1506
1133	sub add_separator {	1507	=item $popup->add_title ($title)
1134	my ($self, $sep) = @_;
1135		1508
1136	$sep \|\|= "═";	1509	Adds a non-clickable title to the popup.
1137		1510
1138	$self->add_item ({	1511	=cut
1139	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1140	text => "",
1141	render => sub { $sep x $urxvt::TERM->ncol },
1142	activate => sub { },
1143	});
1144	}
1145		1512
1146	sub add_title {	1513	sub add_title {
1147	my ($self, $title) = @_;	1514	my ($self, $title) = @_;
1148		1515
1149	$self->add_item ({	1516	$self->add_item ({
…		…
1151	text => $title,	1518	text => $title,
1152	activate => sub { },	1519	activate => sub { },
1153	});	1520	});
1154	}	1521	}
1155		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
		1548
1156	sub add_button {	1549	sub add_button {
1157	my ($self, $text, $cb) = @_;	1550	my ($self, $text, $cb) = @_;
1158		1551
1159	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1552	$self->add_item ({ type => "button", text => $text, activate => $cb});
1160	}	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
1161		1562
1162	sub add_toggle {	1563	sub add_toggle {
1163	my ($self, $text, $cb, $value) = @_;	1564	my ($self, $text, $cb, $value) = @_;
1164		1565
1165	my $item; $item = {	1566	my $item; $item = {
1166	type => "button",	1567	type => "button",
1167	text => " $text",	1568	text => " $text",
1168	value => $value,	1569	value => $value,
1169	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1570	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1170	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1571	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1171	};	1572	};
1172		1573
1173	$self->add_item ($item);	1574	$self->add_item ($item);
1174	}	1575	}
		1576
		1577	=item $popup->show
		1578
		1579	Displays the popup (which is initially hidden).
		1580
		1581	=cut
1175		1582
1176	sub show {	1583	sub show {
1177	my ($self) = @_;	1584	my ($self) = @_;
1178		1585
1179	local $urxvt::popup::self = $self;	1586	local $urxvt::popup::self = $self;
1180		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"),
1181	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,
1182	"--transient-for" => $self->{term}->parent,	1595	"--transient-for" => $self->{term}->parent,
		1596	"-display" => $self->{term}->display_id,
1183	"-pe" => "urxvt-popup")	1597	"-pe" => "urxvt-popup")
1184	or die "unable to create popup window\n";	1598	or die "unable to create popup window\n";
1185	}	1599	}
1186		1600
1187	sub DESTROY {	1601	sub DESTROY {
1188	my ($self) = @_;	1602	my ($self) = @_;
1189		1603
1190	delete $self->{term}{_destroy}{$self};	1604	delete $self->{term}{_destroy}{$self};
1191	$self->{term}->ungrab;	1605	$self->{term}->ungrab;
1192	}	1606	}
		1607
		1608	=back
1193		1609
1194	=head2 The C<urxvt::timer> Class	1610	=head2 The C<urxvt::timer> Class
1195		1611
1196	This class implements timer watchers/events. Time is represented as a	1612	This class implements timer watchers/events. Time is represented as a
1197	fractional number of seconds since the epoch. Example:	1613	fractional number of seconds since the epoch. Example:
…		…
1250		1666
1251	$term->{socket} = ...	1667	$term->{socket} = ...
1252	$term->{iow} = urxvt::iow	1668	$term->{iow} = urxvt::iow
1253	->new	1669	->new
1254	->fd (fileno $term->{socket})	1670	->fd (fileno $term->{socket})
1255	->events (1) # wait for read data	1671	->events (urxvt::EVENT_READ)
1256	->start	1672	->start
1257	->cb (sub {	1673	->cb (sub {
1258	my ($iow, $revents) = @_;	1674	my ($iow, $revents) = @_;
1259	# $revents must be 1 here, no need to check	1675	# $revents must be 1 here, no need to check
1260	sysread $term->{socket}, my $buf, 8192	1676	sysread $term->{socket}, my $buf, 8192
…		…
1277		1693
1278	Set the filedescriptor (not handle) to watch.	1694	Set the filedescriptor (not handle) to watch.
1279		1695
1280	=item $iow = $iow->events ($eventmask)	1696	=item $iow = $iow->events ($eventmask)
1281		1697
1282	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
1283	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>.
1284		1701
1285	=item $iow = $iow->start	1702	=item $iow = $iow->start
1286		1703
1287	Start watching for requested events on the given handle.	1704	Start watching for requested events on the given handle.
1288		1705
…		…
1303		1720
1304	=item == 0 - fatal messages	1721	=item == 0 - fatal messages
1305		1722
1306	=item >= 3 - script loading and management	1723	=item >= 3 - script loading and management
1307		1724
1308	=item >=10 - all events received	1725	=item >=10 - all called hooks
		1726
		1727	=item >=11 - hook reutrn values
1309		1728
1310	=back	1729	=back
1311		1730
1312	=head1 AUTHOR	1731	=head1 AUTHOR
1313		1732

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.58 by root, Sun Jan 8 22:58:13 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.58 by root, Sun Jan 8 22:58:13 2006 UTC vs.
Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC