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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC vs.
Revision 1.100 by root, Wed Jan 18 08:33:34 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	=item searchable-scrollback<hotkey> (enabled by default)
		95
		96	Adds regex search functionality to the scrollback buffer, triggered
		97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		98	input/output is suspended and a regex is displayed at the bottom of the
		99	screen.
		100
		101	Inputting characters appends them to the regex and continues incremental
		102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		104	bottom. C<Escape> leaves search mode and returns to the point where search
		105	was started, while C<Enter> or C<Return> stay at the current position and
		106	additionally stores the first match in the current line into the primary
		107	selection.
		108
		109	=item selection-autotransform
		110
		111	This selection allows you to do automatic transforms on a selection
		112	whenever a selection is made.
		113
		114	It works by specifying perl snippets (most useful is a single C<s///>
		115	operator) that modify C<$_> as resources:
		116
		117	URxvt.selection-autotransform.0: transform
		118	URxvt.selection-autotransform.1: transform
		119	...
		120
		121	For example, the following will transform selections of the form
		122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		123	$word>:
		124
		125	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		126
		127	And this example matches the same,but replaces it with vi-commands you can
		128	paste directly into your (vi :) editor:
		129
		130	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		131
		132	Of course, this can be modified to suit your needs and your editor :)
		133
		134	To expand the example above to typical perl error messages ("XXX at
		135	FILENAME line YYY."), you need a slightly more elaborate solution:
		136
		137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		139
		140	The first line tells the selection code to treat the unchanging part of
		141	every error message as a selection pattern, and the second line transforms
		142	the message into vi commands to load the file.
69		143
70	=item mark-urls	144	=item mark-urls
71		145
72	Uses per-line display filtering (C<on_line_update>) to underline urls.	146	Uses per-line display filtering (C<on_line_update>) to underline urls and
		147	make them clickable. When middle-clicked, the program specified in the
		148	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		149	the URL as first argument.
73		150
74	=item block-graphics-to-ascii	151	=item block-graphics-to-ascii
75		152
76	A not very useful example of filtering all text output to the terminal,	153	A not very useful example of filtering all text output to the terminal,
77	by replacing all line-drawing characters (U+2500 .. U+259F) by a	154	by replacing all line-drawing characters (U+2500 .. U+259F) by a
78	similar-looking ascii character.	155	similar-looking ascii character.
79		156
		157	=item digital-clock
		158
		159	Displays a digital clock using the built-in overlay.
		160
80	=item example-refresh-hooks	161	=item example-refresh-hooks
81		162
82	Displays a very simple digital clock in the upper right corner of the	163	Displays a very simple digital clock in the upper right corner of the
83	window. Illustrates overwriting the refresh callbacks to create your own	164	window. Illustrates overwriting the refresh callbacks to create your own
84	overlays or changes.	165	overlays or changes.
85		166
		167	=item selection-pastebin
		168
		169	This is a little rarely useful extension that Uploads the selection as
		170	textfile to a remote site (or does other things). (The implementation is
		171	not currently secure for use in a multiuser environment as it writes to
		172	F</tmp> directly.).
		173
		174	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		175	i.e.
		176
		177	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		178
		179	Pressing this combination runs a command with C<%> replaced by the name of
		180	the textfile. This command can be set via a resource:
		181
		182	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		183
		184	And the default is likely not useful to anybody but the few people around
		185	here :)
		186
		187	The name of the textfile is the hex encoded md5 sum of the selection, so
		188	the same content should lead to the same filename.
		189
		190	After a successful upload the selection will be replaced by the text given
		191	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		192	for the filename):
		193
		194	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		195
86	=back	196	=back
		197
		198	=head1 API DOCUMENTATION
87		199
88	=head2 General API Considerations	200	=head2 General API Considerations
89		201
90	All objects (such as terminals, time watchers etc.) are typical	202	All objects (such as terminals, time watchers etc.) are typical
91	reference-to-hash objects. The hash can be used to store anything you	203	reference-to-hash objects. The hash can be used to store anything you
…		…
104	=over 4	216	=over 4
105		217
106	=item $text	218	=item $text
107		219
108	Rxvt-unicodes special way of encoding text, where one "unicode" character	220	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.	221	always represents one screen cell. See L<ROW_t> for a discussion of this format.
110		222
111	=item $string	223	=item $string
112		224
113	A perl text string, with an emphasis on I<text>. It can store all unicode	225	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	226	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	231	Either binary data or - more common - a text string encoded in a
120	locale-specific way.	232	locale-specific way.
121		233
122	=back	234	=back
123		235
		236	=head2 Extension Objects
		237
		238	Very perl extension is a perl class. A separate perl object is created
		239	for each terminal and each extension and passed as the first parameter to
		240	hooks. So extensions can use their C<$self> object without having to think
		241	about other extensions, with the exception of methods and members that
		242	begin with an underscore character C<_>: these are reserved for internal
		243	use.
		244
		245	Although it isn't a C<urxvt::term> object, you can call all methods of the
		246	C<urxvt::term> class on this object.
		247
		248	It has the following methods and data members:
		249
		250	=over 4
		251
		252	=item $urxvt_term = $self->{term}
		253
		254	Returns the C<urxvt::term> object associated with this instance of the
		255	extension. This member I<must not> be changed in any way.
		256
		257	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		258
		259	Dynamically enable the given hooks (named without the C<on_> prefix) for
		260	this extension, replacing any previous hook. This is useful when you want
		261	to overwrite time-critical hooks only temporarily.
		262
		263	=item $self->disable ($hook_name[, $hook_name..])
		264
		265	Dynamically disable the given hooks.
		266
		267	=back
		268
124	=head2 Hooks	269	=head2 Hooks
125		270
126	The following subroutines can be declared in extension files, and will be	271	The following subroutines can be declared in extension files, and will be
127	called whenever the relevant event happens.	272	called whenever the relevant event happens.
128		273
129	The first argument passed to them is an object private to each terminal	274	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	275	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		276
136	All of them must return a boolean value. If it is true, then the event	277	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,	278	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.	279	skipped, and the relevant action might not be carried out by the C++ code.
139		280
140	When in doubt, return a false value (preferably C<()>).	281	I<< When in doubt, return a false value (preferably C<()>). >>
141		282
142	=over 4	283	=over 4
143		284
144	=item on_init $term	285	=item on_init $term
145		286
…		…
180	=item on_sel_extend $term	321	=item on_sel_extend $term
181		322
182	Called whenever the user tries to extend the selection (e.g. with a double	323	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	324	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	325	should extend the selection itelf and return true to suppress the built-in
185	processing.	326	processing. This can happen multiple times, as long as the callback
		327	returns true, it will be called on every further click by the user and is
		328	supposed to enlarge the selection more and more, if possible.
186		329
187	See the F<selection> example extension.	330	See the F<selection> example extension.
188		331
189	=item on_view_change $term, $offset	332	=item on_view_change $term, $offset
190		333
…		…
199	than the scroll back buffer or the terminal.	342	than the scroll back buffer or the terminal.
200		343
201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	344	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	345	$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.	346	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		347
209	=item on_osc_seq $term, $string	348	=item on_osc_seq $term, $string
210		349
211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	350	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212	operating system command) is processed. Cursor position and other state	351	operating system command) is processed. Cursor position and other state
…		…
225	can filter/change and output the text yourself by returning a true value	364	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	365	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	366	might be very slow, however, as your hook is called for B<all> text being
228	output.	367	output.
229		368
		369	=item on_tt_write $term, $octets
		370
		371	Called whenever some data is written to the tty/pty and can be used to
		372	suppress or filter tty input.
		373
230	=item on_line_update $term, $row	374	=item on_line_update $term, $row
231		375
232	Called whenever a line was updated or changed. Can be used to filter	376	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	377	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,	378	that are being shown will be filtered, and, due to performance reasons,
…		…
256		400
257	Called whenever the user presses a key combination that has a	401	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>	402	C<perl:string> action bound to it (see description of the B<keysym>
259	resource in the @@RXVT_NAME@@(1) manpage).	403	resource in the @@RXVT_NAME@@(1) manpage).
260		404
		405	=item on_x_event $term, $event
		406
		407	Called on every X event received on the vt window (and possibly other
		408	windows). Should only be used as a last resort. Most event structure
		409	members are not passed.
		410
261	=item on_focus_in $term	411	=item on_focus_in $term
262		412
263	Called whenever the window gets the keyboard focus, before rxvt-unicode	413	Called whenever the window gets the keyboard focus, before rxvt-unicode
264	does focus in processing.	414	does focus in processing.
265		415
266	=item on_focus_out $term	416	=item on_focus_out $term
267		417
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	418	Called wheneever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	419	focus out processing.
270		420
271	=item on_key_press $term, $event, $octets	421	=item on_key_press $term, $event, $keysym, $octets
272		422
273	=item on_key_release $term, $event	423	=item on_key_release $term, $event, $keysym
274		424
275	=item on_button_press $term, $event	425	=item on_button_press $term, $event
276		426
277	=item on_button_release $term, $event	427	=item on_button_release $term, $event
278		428
…		…
294		444
295	subwindow.	445	subwindow.
296		446
297	=back	447	=back
298		448
		449	=cut
		450
		451	package urxvt;
		452
		453	use utf8;
		454	use strict;
		455	use Carp ();
		456	use Scalar::Util ();
		457	use List::Util ();
		458
		459	our $VERSION = 1;
		460	our $TERM;
		461	our @HOOKNAME;
		462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		463	our %OPTION;
		464
		465	our $LIBDIR;
		466	our $RESNAME;
		467	our $RESCLASS;
		468	our $RXVTNAME;
		469
299	=head2 Variables in the C<urxvt> Package	470	=head2 Variables in the C<urxvt> Package
300		471
301	=over 4	472	=over 4
		473
		474	=item $urxvt::LIBDIR
		475
		476	The rxvt-unicode library directory, where, among other things, the perl
		477	modules and scripts are stored.
		478
		479	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		480
		481	The resource class and name rxvt-unicode uses to look up X resources.
		482
		483	=item $urxvt::RXVTNAME
		484
		485	The basename of the installed binaries, usually C<urxvt>.
302		486
303	=item $urxvt::TERM	487	=item $urxvt::TERM
304		488
305	The current terminal. This variable stores the current C<urxvt::term>	489	The current terminal. This variable stores the current C<urxvt::term>
306	object, whenever a callback/hook is executing.	490	object, whenever a callback/hook is executing.
…		…
308	=back	492	=back
309		493
310	=head2 Functions in the C<urxvt> Package	494	=head2 Functions in the C<urxvt> Package
311		495
312	=over 4	496	=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		497
322	=item urxvt::fatal $errormessage	498	=item urxvt::fatal $errormessage
323		499
324	Fatally aborts execution with the given error message. Avoid at all	500	Fatally aborts execution with the given error message. Avoid at all
325	costs! The only time this is acceptable is when the terminal process	501	costs! The only time this is acceptable is when the terminal process
…		…
332	that calls this function.	508	that calls this function.
333		509
334	Using this function has the advantage that its output ends up in the	510	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.	511	correct place, e.g. on stderr of the connecting urxvtc client.
336		512
		513	Messages have a size limit of 1023 bytes currently.
		514
337	=item $time = urxvt::NOW	515	=item $time = urxvt::NOW
338		516
339	Returns the "current time" (as per the event loop).	517	Returns the "current time" (as per the event loop).
340		518
341	=item urxvt::CurrentTime	519	=item urxvt::CurrentTime
342		520
343	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	521	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	522	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345	Button4Mask, Button5Mask, AnyModifier	523	Button4Mask, Button5Mask, AnyModifier
		524
		525	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		526	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		527	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		528	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		529	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		530	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		531	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		532
		533	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		534	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		535	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		536	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		537	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		538	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		539	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
346		540
347	Various constants for use in X calls and event processing.	541	Various constants for use in X calls and event processing.
348		542
349	=back	543	=back
350		544
…		…
379		573
380	=item $background = urxvt::GET_BASEBG $rend	574	=item $background = urxvt::GET_BASEBG $rend
381		575
382	Return the foreground/background colour index, respectively.	576	Return the foreground/background colour index, respectively.
383		577
384	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	578	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385		579
386	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	580	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
387		581
388	Replace the foreground/background colour in the rendition mask with the	582	Replace the foreground/background colour in the rendition mask with the
389	specified one.	583	specified one.
390		584
391	=item $value = urxvt::GET_CUSTOM ($rend)	585	=item $value = urxvt::GET_CUSTOM $rend
392		586
393	Return the "custom" value: Every rendition has 5 bits for use by	587	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	588	extensions. They can be set and changed as you like and are initially
395	zero.	589	zero.
396		590
397	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	591	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398		592
399	Change the custom value.	593	Change the custom value.
400		594
401	=back	595	=back
402		596
403	=cut	597	=cut
404		598
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 {	599	BEGIN {
419	urxvt->bootstrap;
420
421	# overwrite perl's warn	600	# overwrite perl's warn
422	*CORE::GLOBAL::warn = sub {	601	*CORE::GLOBAL::warn = sub {
423	my $msg = join "", @_;	602	my $msg = join "", @_;
424	$msg .= "\n"	603	$msg .= "\n"
425	unless $msg =~ /\n$/;	604	unless $msg =~ /\n$/;
426	urxvt::warn ($msg);	605	urxvt::warn ($msg);
427	};	606	};
428	}
429		607
430	my @hook_count;	608	# %ENV is the original startup environment
		609	delete $ENV{IFS};
		610	delete $ENV{CDPATH};
		611	delete $ENV{BASH_ENV};
		612	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
		613	}
		614
431	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	615	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
432		616
433	sub verbose {	617	sub verbose {
434	my ($level, $msg) = @_;	618	my ($level, $msg) = @_;
435	warn "$msg\n" if $level <= $verbosity;	619	warn "$msg\n" if $level <= $verbosity;
436	}	620	}
437		621
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;	622	my %extension_pkg;
457		623
458	# load a single script into its own package, once only	624	# load a single script into its own package, once only
459	sub extension_package($) {	625	sub extension_package($) {
460	my ($path) = @_;	626	my ($path) = @_;
461		627
		628	no strict 'refs';
		629
462	$extension_pkg{$path} \|\|= do {	630	$extension_pkg{$path} \|\|= do {
463	my $pkg = "urxvt::" . ($extension_pkg++);	631	$path =~ /([^\/\\]+)$/;
		632	my $pkg = $1;
		633	$pkg =~ s/[^[:word:]]/_/g;
		634	$pkg = "urxvt::ext::$pkg";
464		635
465	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
466		637
467	open my $fh, "<:raw", $path	638	open my $fh, "<:raw", $path
468	or die "$path: $!";	639	or die "$path: $!";
469		640
		641	@{"$pkg\::ISA"} = urxvt::term::extension::;
		642
		643	my $source =
470	my $source = "package $pkg; use strict; use utf8;\n"	644	"package $pkg; use strict; use utf8;\n"
471	. "use base urxvt::term::proxy::;\n"
472	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
473	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
474	. "\n};\n1";	647	. "\n};\n1";
475		648
476	$source =~ /(.*)/s and $source = $1; # untaint	649	eval $source
477
478	eval $source or die "$path: $@";	650	or die "$path: $@";
479		651
480	$pkg	652	$pkg
481	}	653	}
482	}	654	}
483		655
…		…
489	my $htype = shift;	661	my $htype = shift;
490		662
491	if ($htype == 0) { # INIT	663	if ($htype == 0) { # INIT
492	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
493		665
494	my %want_ext;	666	my %ext_arg;
495		667
496	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	668	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
497	if ($_ eq "default") {	669	if ($_ eq "default") {
498	$want_ext{$_}++ for qw(selection option-popup);	670	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
499	} elsif (/^-(.*)$/) {	671	} elsif (/^-(.*)$/) {
500	delete $want_ext{$1};	672	delete $ext_arg{$1};
		673	} elsif (/^([^<]+)<(.*)>$/) {
		674	push @{ $ext_arg{$1} }, $2;
501	} else {	675	} else {
502	$want_ext{$_}++;	676	$ext_arg{$_} \|\|= [];
503	}	677	}
504	}	678	}
505		679
506	for my $ext (keys %want_ext) {	680	while (my ($ext, $argv) = each %ext_arg) {
507	my @files = grep -f $_, map "$_/$ext", @dirs;	681	my @files = grep -f $_, map "$_/$ext", @dirs;
508		682
509	if (@files) {	683	if (@files) {
510	register_package extension_package $files[0];	684	$TERM->register_package (extension_package $files[0], $argv);
511	} else {	685	} else {
512	warn "perl extension '$ext' not found in perl library search path\n";	686	warn "perl extension '$ext' not found in perl library search path\n";
513	}	687	}
514	}	688	}
515		689
…		…
524	if $verbosity >= 10;	698	if $verbosity >= 10;
525		699
526	keys %$cb;	700	keys %$cb;
527		701
528	while (my ($pkg, $cb) = each %$cb) {	702	while (my ($pkg, $cb) = each %$cb) {
529	eval {	703	$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;	704	and last;
538	};
539	warn $@ if $@;#d#
540	}
541	}
542		705
543	if ($htype == 1) { # DESTROY	706	if ($@) {
544	# remove hooks if unused	707	$TERM->ungrab; # better to lose the grab than the session
545	if (my $hook = $TERM->{_hook}) {	708	warn $@;
546	for my $htype (0..$#$hook) {
547	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
548	or set_should_invoke $htype, 0;
549	}	709	}
550	}	710	}
551		711
		712	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		713	if $verbosity >= 11;
		714	}
		715
		716	if ($htype == 1) { # DESTROY
552	# clear package objects	717	# clear package objects
553	%$_ = () for values %{ $TERM->{_pkg} };	718	%$_ = () for values %{ $TERM->{_pkg} };
554		719
555	# clear package	720	# clear package
556	%$TERM = ();	721	%$TERM = ();
557	}	722	}
558		723
559	$retval	724	$retval
560	}	725	}
561		726
562	# urxvt::term::proxy	727	sub exec_async(@) {
		728	my $pid = fork;
563		729
564	sub urxvt::term::proxy::AUTOLOAD {	730	return
565	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	731	if !defined $pid or $pid;
		732
		733	%ENV = %{ $TERM->env };
		734
		735	exec @_;
		736	_exit 255;
		737	}
		738
		739	# urxvt::term::extension
		740
		741	package urxvt::term::extension;
		742
		743	sub enable {
		744	my ($self, %hook) = @_;
		745	my $pkg = $self->{_pkg};
		746
		747	while (my ($name, $cb) = each %hook) {
		748	my $htype = $HOOKTYPE{uc $name};
		749	defined $htype
		750	or Carp::croak "unsupported hook type '$name'";
		751
		752	$self->set_should_invoke ($htype, +1)
		753	unless exists $self->{term}{_hook}[$htype]{$pkg};
		754
		755	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		756	}
		757	}
		758
		759	sub disable {
		760	my ($self, @hook) = @_;
		761	my $pkg = $self->{_pkg};
		762
		763	for my $name (@hook) {
		764	my $htype = $HOOKTYPE{uc $name};
		765	defined $htype
		766	or Carp::croak "unsupported hook type '$name'";
		767
		768	$self->set_should_invoke ($htype, -1)
		769	if delete $self->{term}{_hook}[$htype]{$pkg};
		770	}
		771	}
		772
		773	our $AUTOLOAD;
		774
		775	sub AUTOLOAD {
		776	$AUTOLOAD =~ /:([^:]+)$/
566	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	777	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
567		778
568	eval qq{	779	eval qq{
569	sub $urxvt::term::proxy::AUTOLOAD {	780	sub $AUTOLOAD {
570	my \$proxy = shift;	781	my \$proxy = shift;
571	\$proxy->{term}->$1 (\@_)	782	\$proxy->{term}->$1 (\@_)
572	}	783	}
573	1	784	1
574	} or die "FATAL: unable to compile method forwarder: $@";	785	} or die "FATAL: unable to compile method forwarder: $@";
575		786
576	goto &$urxvt::term::proxy::AUTOLOAD;	787	goto &$AUTOLOAD;
		788	}
		789
		790	sub DESTROY {
		791	# nop
577	}	792	}
578		793
579	# urxvt::destroy_hook	794	# urxvt::destroy_hook
580		795
581	sub urxvt::destroy_hook::DESTROY {	796	sub urxvt::destroy_hook::DESTROY {
…		…
590		805
591	=head2 The C<urxvt::anyevent> Class	806	=head2 The C<urxvt::anyevent> Class
592		807
593	The sole purpose of this class is to deliver an interface to the	808	The sole purpose of this class is to deliver an interface to the
594	C<AnyEvent> module - any module using it will work inside urxvt without	809	C<AnyEvent> module - any module using it will work inside urxvt without
595	further work. The only exception is that you cannot wait on condition	810	further programming. The only exception is that you cannot wait on
596	variables, but non-blocking condvar use is ok. What this means is that you	811	condition variables, but non-blocking condvar use is ok. What this means
597	cannot use blocking APIs, but the non-blocking variant should work.	812	is that you cannot use blocking APIs, but the non-blocking variant should
		813	work.
598		814
599	=cut	815	=cut
600		816
601	our $VERSION = 1;	817	our $VERSION = 1;
602		818
…		…
647	${$_[0]}++;	863	${$_[0]}++;
648	}	864	}
649		865
650	sub urxvt::anyevent::condvar::wait {	866	sub urxvt::anyevent::condvar::wait {
651	unless (${$_[0]}) {	867	unless (${$_[0]}) {
652	require Carp;
653	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	868	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
654	}	869	}
655	}	870	}
656		871
657	package urxvt::term;	872	package urxvt::term;
658		873
659	=head2 The C<urxvt::term> Class	874	=head2 The C<urxvt::term> Class
660		875
661	=over 4	876	=over 4
662		877
		878	=cut
		879
		880	# find on_xxx subs in the package and register them
		881	# as hooks
		882	sub register_package {
		883	my ($self, $pkg, $argv) = @_;
		884
		885	my $proxy = bless {
		886	_pkg => $pkg,
		887	argv => $argv,
		888	}, $pkg;
		889	Scalar::Util::weaken ($proxy->{term} = $self);
		890
		891	$self->{_pkg}{$pkg} = $proxy;
		892
		893	for my $name (@HOOKNAME) {
		894	if (my $ref = $pkg->can ("on_" . lc $name)) {
		895	$proxy->enable ($name => $ref);
		896	}
		897	}
		898	}
		899
		900	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		901
		902	Creates a new terminal, very similar as if you had started it with system
		903	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		904	hash which defines the environment of the new terminal.
		905
		906	Croaks (and probably outputs an error message) if the new instance
		907	couldn't be created. Returns C<undef> if the new instance didn't
		908	initialise perl, and the terminal object otherwise. The C<init> and
		909	C<start> hooks will be called during this call.
		910
		911	=cut
		912
		913	sub new {
		914	my ($class, $env, @args) = @_;
		915
		916	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		917	}
		918
663	=item $term->destroy	919	=item $term->destroy
664		920
665	Destroy the terminal object (close the window, free resources etc.).	921	Destroy the terminal object (close the window, free resources
		922	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		923	watchers (timers, io watchers) are still active.
666		924
667	=item $isset = $term->option ($optval[, $set])	925	=item $isset = $term->option ($optval[, $set])
668		926
669	Returns true if the option specified by C<$optval> is enabled, and	927	Returns true if the option specified by C<$optval> is enabled, and
670	optionally change it. All option values are stored by name in the hash	928	optionally change it. All option values are stored by name in the hash
…		…
720	my ($self, $name) = (shift, shift);	978	my ($self, $name) = (shift, shift);
721	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	979	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
722	&urxvt::term::_resource	980	&urxvt::term::_resource
723	}	981	}
724		982
		983	=item $value = $term->x_resource ($pattern)
		984
		985	Returns the X-Resource for the given pattern, excluding the program or
		986	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		987	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		988	resource with that pattern exists.
		989
		990	This method should only be called during the C<on_start> hook, as there is
		991	only one resource database per display, and later invocations might return
		992	the wrong resources.
		993
		994	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		995
		996	Adds a keymap translation exactly as specified via a resource. See the
		997	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		998
725	=item $rend = $term->rstyle ([$new_rstyle])	999	=item $rend = $term->rstyle ([$new_rstyle])
726		1000
727	Return and optionally change the current rendition. Text that is output by	1001	Return and optionally change the current rendition. Text that is output by
728	the terminal application will use this style.	1002	the terminal application will use this style.
729		1003
…		…
739	=item ($row, $col) = $term->selection_end ([$row, $col])	1013	=item ($row, $col) = $term->selection_end ([$row, $col])
740		1014
741	Return the current values of the selection mark, begin or end positions,	1015	Return the current values of the selection mark, begin or end positions,
742	and optionally set them to new values.	1016	and optionally set them to new values.
743		1017
		1018	=item $term->selection_make ($eventtime[, $rectangular])
		1019
		1020	Tries to make a selection as set by C<selection_beg> and
		1021	C<selection_end>. If C<$rectangular> is true (default: false), a
		1022	rectangular selection will be made. This is the prefered function to make
		1023	a selection.
		1024
744	=item $success = $term->selection_grab ($eventtime)	1025	=item $success = $term->selection_grab ($eventtime)
745		1026
746	Try to request the primary selection from the server (for example, as set	1027	Try to request the primary selection text from the server (for example, as
747	by the next method).	1028	set by the next method). No visual feedback will be given. This function
		1029	is mostly useful from within C<on_sel_grab> hooks.
748		1030
749	=item $oldtext = $term->selection ([$newtext])	1031	=item $oldtext = $term->selection ([$newtext])
750		1032
751	Return the current selection text and optionally replace it by C<$newtext>.	1033	Return the current selection text and optionally replace it by C<$newtext>.
752		1034
753	#=item $term->overlay ($x, $y, $text)	1035	=item $term->overlay_simple ($x, $y, $text)
754	#	1036
755	#Create a simple multi-line overlay box. See the next method for details.	1037	Create a simple multi-line overlay box. See the next method for details.
756	#	1038
757	#=cut	1039	=cut
758	#	1040
759	#sub urxvt::term::scr_overlay {	1041	sub overlay_simple {
760	# my ($self, $x, $y, $text) = @_;	1042	my ($self, $x, $y, $text) = @_;
761	#	1043
762	# my @lines = split /\n/, $text;	1044	my @lines = split /\n/, $text;
763	#	1045
764	# my $w = 0;	1046	my $w = List::Util::max map $self->strwidth ($_), @lines;
765	# for (map $self->strwidth ($_), @lines) {	1047
766	# $w = $_ if $w < $_;
767	# }
768	#
769	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1048	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
770	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1049	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
771	#}	1050
		1051	$overlay
		1052	}
772		1053
773	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1054	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
774		1055
775	Create a new (empty) overlay at the given position with the given	1056	Create a new (empty) overlay at the given position with the given
776	width/height. C<$rstyle> defines the initial rendition style	1057	width/height. C<$rstyle> defines the initial rendition style
…		…
843		1124
844	=item $string = $term->locale_decode ($octets)	1125	=item $string = $term->locale_decode ($octets)
845		1126
846	Convert the given locale-encoded octets into a perl string.	1127	Convert the given locale-encoded octets into a perl string.
847		1128
		1129	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1130
		1131	XORs the rendition values in the given span with the provided value
		1132	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1133	refresh hooks to provide effects similar to the selection.
		1134
		1135	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1136
		1137	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1138	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1139	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1140	it instead. Both styles I<MUST NOT> contain font styles.
		1141
		1142	=item $term->scr_bell
		1143
		1144	Ring the bell!
		1145
848	=item $term->scr_add_lines ($string)	1146	=item $term->scr_add_lines ($string)
849		1147
850	Write the given text string to the screen, as if output by the application	1148	Write the given text string to the screen, as if output by the application
851	running inside the terminal. It may not contain command sequences (escape	1149	running inside the terminal. It may not contain command sequences (escape
852	codes), but is free to use line feeds, carriage returns and tabs. The	1150	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
866		1164
867	Write the octets given in C<$data> to the tty (i.e. as program input). To	1165	Write the octets given in C<$data> to the tty (i.e. as program input). To
868	pass characters instead of octets, you should convert your strings first	1166	pass characters instead of octets, you should convert your strings first
869	to the locale-specific encoding using C<< $term->locale_encode >>.	1167	to the locale-specific encoding using C<< $term->locale_encode >>.
870		1168
		1169	=item $old_events = $term->pty_ev_events ([$new_events])
		1170
		1171	Replaces the event mask of the pty watcher by the given event mask. Can
		1172	be used to suppress input and output handling to the pty/tty. See the
		1173	description of C<< urxvt::timer->events >>. Make sure to always restore
		1174	the previous value.
		1175
871	=item $windowid = $term->parent	1176	=item $windowid = $term->parent
872		1177
873	Return the window id of the toplevel window.	1178	Return the window id of the toplevel window.
874		1179
875	=item $windowid = $term->vt	1180	=item $windowid = $term->vt
876		1181
877	Return the window id of the terminal window.	1182	Return the window id of the terminal window.
878		1183
		1184	=item $term->vt_emask_add ($x_event_mask)
		1185
		1186	Adds the specified events to the vt event mask. Useful e.g. when you want
		1187	to receive pointer events all the times:
		1188
		1189	$term->vt_emask_add (urxvt::PointerMotionMask);
		1190
879	=item $window_width = $term->width	1191	=item $window_width = $term->width
880		1192
881	=item $window_height = $term->height	1193	=item $window_height = $term->height
882		1194
883	=item $font_width = $term->fwidth	1195	=item $font_width = $term->fwidth
…		…
896		1208
897	=item $max_scrollback = $term->saveLines	1209	=item $max_scrollback = $term->saveLines
898		1210
899	=item $nrow_plus_saveLines = $term->total_rows	1211	=item $nrow_plus_saveLines = $term->total_rows
900		1212
901	=item $lines_in_scrollback = $term->nsaved	1213	=item $topmost_scrollback_row = $term->top_row
902		1214
903	Return various integers describing terminal characteristics.	1215	Return various integers describing terminal characteristics.
		1216
		1217	=item $x_display = $term->display_id
		1218
		1219	Return the DISPLAY used by rxvt-unicode.
		1220
		1221	=item $lc_ctype = $term->locale
		1222
		1223	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1224
		1225	=item $env = $term->env
		1226
		1227	Returns a copy of the environment in effect for the terminal as a hashref
		1228	similar to C<\%ENV>.
		1229
		1230	=cut
		1231
		1232	sub env {
		1233	if (my $env = $_[0]->_env) {
		1234	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1235	} else {
		1236	+{ %ENV }
		1237	}
		1238	}
904		1239
905	=item $modifiermask = $term->ModLevel3Mask	1240	=item $modifiermask = $term->ModLevel3Mask
906		1241
907	=item $modifiermask = $term->ModMetaMask	1242	=item $modifiermask = $term->ModMetaMask
908		1243
…		…
911	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1246	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
912	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1247	AltGr), the meta key (often Alt) and the num lock key, if applicable.
913		1248
914	=item $view_start = $term->view_start ([$newvalue])	1249	=item $view_start = $term->view_start ([$newvalue])
915		1250
916	Returns the negative row number of the topmost line. Minimum value is	1251	Returns the row number of the topmost displayed line. Maximum value is
917	C<0>, which displays the normal terminal contents. Larger values scroll	1252	C<0>, which displays the normal terminal contents. Lower values scroll
918	this many lines into the scrollback buffer.	1253	this many lines into the scrollback buffer.
919		1254
920	=item $term->want_refresh	1255	=item $term->want_refresh
921		1256
922	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1257	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1001	Return the row number of the first/last row of the line, respectively.	1336	Return the row number of the first/last row of the line, respectively.
1002		1337
1003	=item $offset = $line->offset_of ($row, $col)	1338	=item $offset = $line->offset_of ($row, $col)
1004		1339
1005	Returns the character offset of the given row\|col pair within the logical	1340	Returns the character offset of the given row\|col pair within the logical
1006	line.	1341	line. Works for rows outside the line, too, and returns corresponding
		1342	offsets outside the string.
1007		1343
1008	=item ($row, $col) = $line->coord_of ($offset)	1344	=item ($row, $col) = $line->coord_of ($offset)
1009		1345
1010	Translates a string offset into terminal coordinates again.	1346	Translates a string offset into terminal coordinates again.
1011		1347
…		…
1085	$offset / $self->{ncol} + $self->{beg},	1421	$offset / $self->{ncol} + $self->{beg},
1086	$offset % $self->{ncol}	1422	$offset % $self->{ncol}
1087	)	1423	)
1088	}	1424	}
1089		1425
1090	=item ($row, $col) = $line->coord_of ($offset)
1091	=item $text = $term->special_encode $string	1426	=item $text = $term->special_encode $string
1092		1427
1093	Converts a perl string into the special encoding used by rxvt-unicode,	1428	Converts a perl string into the special encoding used by rxvt-unicode,
1094	where one character corresponds to one screen cell. See	1429	where one character corresponds to one screen cell. See
1095	C<< $term->ROW_t >> for details.	1430	C<< $term->ROW_t >> for details.
…		…
1097	=item $string = $term->special_decode $text	1432	=item $string = $term->special_decode $text
1098		1433
1099	Converts rxvt-unicodes text reprsentation into a perl string. See	1434	Converts rxvt-unicodes text reprsentation into a perl string. See
1100	C<< $term->ROW_t >> for details.	1435	C<< $term->ROW_t >> for details.
1101		1436
		1437	=item $success = $term->grab_button ($button, $modifiermask)
		1438
		1439	Registers a synchronous button grab. See the XGrabButton manpage.
		1440
		1441	=item $success = $term->grab ($eventtime[, $sync])
		1442
		1443	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1444	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1445
		1446	=item $term->allow_events_async
		1447
		1448	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1449
		1450	=item $term->allow_events_sync
		1451
		1452	Calls XAllowEvents with SyncBoth for the most recent grab.
		1453
		1454	=item $term->allow_events_replay
		1455
		1456	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1457	recent grab.
		1458
		1459	=item $term->ungrab
		1460
		1461	Calls XUngrab for the most recent grab. Is called automatically on
		1462	evaluation errors, as it is better to lose the grab in the error case as
		1463	the session.
		1464
1102	=back	1465	=back
1103		1466
1104	=cut	1467	=cut
1105		1468
1106	package urxvt::popup;	1469	package urxvt::popup;
…		…
1121	$item->{render} \|\|= sub { $_[0]{text} };	1484	$item->{render} \|\|= sub { $_[0]{text} };
1122		1485
1123	push @{ $self->{item} }, $item;	1486	push @{ $self->{item} }, $item;
1124	}	1487	}
1125		1488
1126	sub add_separator {	1489	=item $popup->add_title ($title)
1127	my ($self, $sep) = @_;
1128		1490
1129	$sep \|\|= "═";	1491	Adds a non-clickable title to the popup.
1130		1492
1131	$self->add_item ({	1493	=cut
1132	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1133	text => "",
1134	render => sub { $sep x $urxvt::TERM->ncol },
1135	activate => sub { },
1136	});
1137	}
1138		1494
1139	sub add_title {	1495	sub add_title {
1140	my ($self, $title) = @_;	1496	my ($self, $title) = @_;
1141		1497
1142	$self->add_item ({	1498	$self->add_item ({
…		…
1144	text => $title,	1500	text => $title,
1145	activate => sub { },	1501	activate => sub { },
1146	});	1502	});
1147	}	1503	}
1148		1504
		1505	=item $popup->add_separator ([$sepchr])
		1506
		1507	Creates a separator, optionally using the character given as C<$sepchr>.
		1508
		1509	=cut
		1510
		1511	sub add_separator {
		1512	my ($self, $sep) = @_;
		1513
		1514	$sep \|\|= "=";
		1515
		1516	$self->add_item ({
		1517	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1518	text => "",
		1519	render => sub { $sep x $self->{term}->ncol },
		1520	activate => sub { },
		1521	});
		1522	}
		1523
		1524	=item $popup->add_button ($text, $cb)
		1525
		1526	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1527	selected.
		1528
		1529	=cut
		1530
1149	sub add_button {	1531	sub add_button {
1150	my ($self, $text, $cb) = @_;	1532	my ($self, $text, $cb) = @_;
1151		1533
1152	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1534	$self->add_item ({ type => "button", text => $text, activate => $cb});
1153	}	1535	}
		1536
		1537	=item $popup->add_toggle ($text, $cb, $initial_value)
		1538
		1539	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1540	whenever it gets toggled, with a boolean indicating its value as its first
		1541	argument.
		1542
		1543	=cut
1154		1544
1155	sub add_toggle {	1545	sub add_toggle {
1156	my ($self, $text, $cb, $value) = @_;	1546	my ($self, $text, $cb, $value) = @_;
1157		1547
1158	my $item; $item = {	1548	my $item; $item = {
1159	type => "button",	1549	type => "button",
1160	text => " $text",	1550	text => " $text",
1161	value => $value,	1551	value => $value,
1162	render => sub { ($item->{value} ? "* " : " ") . $text },	1552	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1163	activate => sub { $cb->($item->{value} = !$item->{value}); },	1553	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1164	};	1554	};
1165		1555
1166	$self->add_item ($item);	1556	$self->add_item ($item);
1167	}	1557	}
		1558
		1559	=item $popup->show
		1560
		1561	Displays the popup (which is initially hidden).
		1562
		1563	=cut
1168		1564
1169	sub show {	1565	sub show {
1170	my ($self) = @_;	1566	my ($self) = @_;
1171		1567
1172	local $urxvt::popup::self = $self;	1568	local $urxvt::popup::self = $self;
1173		1569
		1570	my $env = $self->{term}->env;
		1571	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1572	delete $env->{LC_ALL};
		1573	$env->{LC_CTYPE} = $self->{term}->locale;
		1574
		1575	urxvt::term->new ($env, $self->{term}->resource ("name"),
1174	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1576	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1175	"--transient-for" => $self->{term}->parent,	1577	"--transient-for" => $self->{term}->parent,
		1578	"-display" => $self->{term}->display_id,
1176	"-pe" => "urxvt-popup")	1579	"-pe" => "urxvt-popup")
1177	or die "unable to create popup window\n";	1580	or die "unable to create popup window\n";
1178	}	1581	}
1179		1582
1180	sub DESTROY {	1583	sub DESTROY {
1181	my ($self) = @_;	1584	my ($self) = @_;
1182		1585
		1586	delete $self->{term}{_destroy}{$self};
1183	$self->{term}->ungrab;	1587	$self->{term}->ungrab;
1184	}	1588	}
		1589
		1590	=back
1185		1591
1186	=head2 The C<urxvt::timer> Class	1592	=head2 The C<urxvt::timer> Class
1187		1593
1188	This class implements timer watchers/events. Time is represented as a	1594	This class implements timer watchers/events. Time is represented as a
1189	fractional number of seconds since the epoch. Example:	1595	fractional number of seconds since the epoch. Example:
…		…
1242		1648
1243	$term->{socket} = ...	1649	$term->{socket} = ...
1244	$term->{iow} = urxvt::iow	1650	$term->{iow} = urxvt::iow
1245	->new	1651	->new
1246	->fd (fileno $term->{socket})	1652	->fd (fileno $term->{socket})
1247	->events (1) # wait for read data	1653	->events (urxvt::EVENT_READ)
1248	->start	1654	->start
1249	->cb (sub {	1655	->cb (sub {
1250	my ($iow, $revents) = @_;	1656	my ($iow, $revents) = @_;
1251	# $revents must be 1 here, no need to check	1657	# $revents must be 1 here, no need to check
1252	sysread $term->{socket}, my $buf, 8192	1658	sysread $term->{socket}, my $buf, 8192
…		…
1269		1675
1270	Set the filedescriptor (not handle) to watch.	1676	Set the filedescriptor (not handle) to watch.
1271		1677
1272	=item $iow = $iow->events ($eventmask)	1678	=item $iow = $iow->events ($eventmask)
1273		1679
1274	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1680	Set the event mask to watch. The only allowed values are
1275	data, Bit #1 (value C<2>) enables watching for write data.	1681	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1682	together, or C<urxvt::EVENT_NONE>.
1276		1683
1277	=item $iow = $iow->start	1684	=item $iow = $iow->start
1278		1685
1279	Start watching for requested events on the given handle.	1686	Start watching for requested events on the given handle.
1280		1687
…		…
1291	This variable controls the verbosity level of the perl extension. Higher	1698	This variable controls the verbosity level of the perl extension. Higher
1292	numbers indicate more verbose output.	1699	numbers indicate more verbose output.
1293		1700
1294	=over 4	1701	=over 4
1295		1702
1296	=item =0 - only fatal messages	1703	=item == 0 - fatal messages
1297		1704
1298	=item =3 - script loading and management	1705	=item >= 3 - script loading and management
1299		1706
1300	=item =10 - all events received	1707	=item >=10 - all called hooks
		1708
		1709	=item >=11 - hook reutrn values
1301		1710
1302	=back	1711	=back
1303		1712
1304	=head1 AUTHOR	1713	=head1 AUTHOR
1305		1714

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC vs. Revision 1.100 by root, Wed Jan 18 08:33:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC vs.
Revision 1.100 by root, Wed Jan 18 08:33:34 2006 UTC