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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.59 by root, Mon Jan 9 00:34:36 2006 UTC vs.
Revision 1.97 by elmex, Tue Jan 17 16:53:47 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
…		…
64	runtime.	86	runtime.
65		87
66	=item selection-popup (enabled by default)	88	=item selection-popup (enabled by default)
67		89
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
70		93
71	=item digital-clock	94	=item searchable-scrollback<hotkey> (enabled by default)
72		95
73	Displays a digital clock using the built-in overlay.	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.
74		143
75	=item mark-urls	144	=item mark-urls
76		145
77	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.
78		150
79	=item block-graphics-to-ascii	151	=item block-graphics-to-ascii
80		152
81	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,
82	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
83	similar-looking ascii character.	155	similar-looking ascii character.
84		156
		157	=item digital-clock
		158
		159	Displays a digital clock using the built-in overlay.
		160
85	=item example-refresh-hooks	161	=item example-refresh-hooks
86		162
87	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
88	window. Illustrates overwriting the refresh callbacks to create your own	164	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	165	overlays or changes.
90		166
		167	=item selection-pastebin
		168
		169	Uploads the selection as textfile to a remote site.
		170
		171	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		172
		173	To set the command to upload the file set this resource:
		174
		175	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		176
		177	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
		178	md5 sum of the selection.
		179	After an successful upload the selection will be replaced by the following url
		180	(the % is the placeholder for the filename):
		181
		182	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
		183
91	=back	184	=back
		185
		186	=head1 API DOCUMENTATION
92		187
93	=head2 General API Considerations	188	=head2 General API Considerations
94		189
95	All objects (such as terminals, time watchers etc.) are typical	190	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	191	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	204	=over 4
110		205
111	=item $text	206	=item $text
112		207
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	208	Rxvt-unicodes special way of encoding text, where one "unicode" character
114	always represents one screen cell. See L<row_t> for a discussion of this format.	209	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		210
116	=item $string	211	=item $string
117		212
118	A perl text string, with an emphasis on I<text>. It can store all unicode	213	A perl text string, with an emphasis on I<text>. It can store all unicode
119	characters and is to be distinguished with text encoded in a specific	214	characters and is to be distinguished with text encoded in a specific
…		…
124	Either binary data or - more common - a text string encoded in a	219	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	220	locale-specific way.
126		221
127	=back	222	=back
128		223
		224	=head2 Extension Objects
		225
		226	Very perl extension is a perl class. A separate perl object is created
		227	for each terminal and each extension and passed as the first parameter to
		228	hooks. So extensions can use their C<$self> object without having to think
		229	about other extensions, with the exception of methods and members that
		230	begin with an underscore character C<_>: these are reserved for internal
		231	use.
		232
		233	Although it isn't a C<urxvt::term> object, you can call all methods of the
		234	C<urxvt::term> class on this object.
		235
		236	It has the following methods and data members:
		237
		238	=over 4
		239
		240	=item $urxvt_term = $self->{term}
		241
		242	Returns the C<urxvt::term> object associated with this instance of the
		243	extension. This member I<must not> be changed in any way.
		244
		245	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		246
		247	Dynamically enable the given hooks (named without the C<on_> prefix) for
		248	this extension, replacing any previous hook. This is useful when you want
		249	to overwrite time-critical hooks only temporarily.
		250
		251	=item $self->disable ($hook_name[, $hook_name..])
		252
		253	Dynamically disable the given hooks.
		254
		255	=back
		256
129	=head2 Hooks	257	=head2 Hooks
130		258
131	The following subroutines can be declared in extension files, and will be	259	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	260	called whenever the relevant event happens.
133		261
134	The first argument passed to them is an object private to each terminal	262	The first argument passed to them is an extension oject as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	263	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		264
141	All of them must return a boolean value. If it is true, then the event	265	B<All> of these hooks must return a boolean value. If it is true, then the
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	266	event counts as being I<consumed>, and the invocation of other hooks is
143	and the relevant action might not be carried out by the C++ code.	267	skipped, and the relevant action might not be carried out by the C++ code.
144		268
145	When in doubt, return a false value (preferably C<()>).	269	I<< When in doubt, return a false value (preferably C<()>). >>
146		270
147	=over 4	271	=over 4
148		272
149	=item on_init $term	273	=item on_init $term
150		274
…		…
185	=item on_sel_extend $term	309	=item on_sel_extend $term
186		310
187	Called whenever the user tries to extend the selection (e.g. with a double	311	Called whenever the user tries to extend the selection (e.g. with a double
188	click) and is either supposed to return false (normal operation), or	312	click) and is either supposed to return false (normal operation), or
189	should extend the selection itelf and return true to suppress the built-in	313	should extend the selection itelf and return true to suppress the built-in
190	processing.	314	processing. This can happen multiple times, as long as the callback
		315	returns true, it will be called on every further click by the user and is
		316	supposed to enlarge the selection more and more, if possible.
191		317
192	See the F<selection> example extension.	318	See the F<selection> example extension.
193		319
194	=item on_view_change $term, $offset	320	=item on_view_change $term, $offset
195		321
…		…
204	than the scroll back buffer or the terminal.	330	than the scroll back buffer or the terminal.
205		331
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	332	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
207	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	333	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208	number of lines that will be in the scrollback buffer.	334	number of lines that will be in the scrollback buffer.
209
210	=item on_tty_activity $term NYI
211
212	Called whenever the program(s) running in the urxvt window send output.
213		335
214	=item on_osc_seq $term, $string	336	=item on_osc_seq $term, $string
215		337
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	338	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	339	operating system command) is processed. Cursor position and other state
…		…
230	can filter/change and output the text yourself by returning a true value	352	can filter/change and output the text yourself by returning a true value
231	and calling C<< $term->scr_add_lines >> yourself. Please note that this	353	and calling C<< $term->scr_add_lines >> yourself. Please note that this
232	might be very slow, however, as your hook is called for B<all> text being	354	might be very slow, however, as your hook is called for B<all> text being
233	output.	355	output.
234		356
		357	=item on_tt_write $term, $octets
		358
		359	Called whenever some data is written to the tty/pty and can be used to
		360	suppress or filter tty input.
		361
235	=item on_line_update $term, $row	362	=item on_line_update $term, $row
236		363
237	Called whenever a line was updated or changed. Can be used to filter	364	Called whenever a line was updated or changed. Can be used to filter
238	screen output (e.g. underline urls or other useless stuff). Only lines	365	screen output (e.g. underline urls or other useless stuff). Only lines
239	that are being shown will be filtered, and, due to performance reasons,	366	that are being shown will be filtered, and, due to performance reasons,
…		…
261		388
262	Called whenever the user presses a key combination that has a	389	Called whenever the user presses a key combination that has a
263	C<perl:string> action bound to it (see description of the B<keysym>	390	C<perl:string> action bound to it (see description of the B<keysym>
264	resource in the @@RXVT_NAME@@(1) manpage).	391	resource in the @@RXVT_NAME@@(1) manpage).
265		392
		393	=item on_x_event $term, $event
		394
		395	Called on every X event received on the vt window (and possibly other
		396	windows). Should only be used as a last resort. Most event structure
		397	members are not passed.
		398
266	=item on_focus_in $term	399	=item on_focus_in $term
267		400
268	Called whenever the window gets the keyboard focus, before rxvt-unicode	401	Called whenever the window gets the keyboard focus, before rxvt-unicode
269	does focus in processing.	402	does focus in processing.
270		403
271	=item on_focus_out $term	404	=item on_focus_out $term
272		405
273	Called wheneever the window loses keyboard focus, before rxvt-unicode does	406	Called wheneever the window loses keyboard focus, before rxvt-unicode does
274	focus out processing.	407	focus out processing.
275		408
276	=item on_key_press $term, $event, $octets	409	=item on_key_press $term, $event, $keysym, $octets
277		410
278	=item on_key_release $term, $event	411	=item on_key_release $term, $event, $keysym
279		412
280	=item on_button_press $term, $event	413	=item on_button_press $term, $event
281		414
282	=item on_button_release $term, $event	415	=item on_button_release $term, $event
283		416
…		…
299		432
300	subwindow.	433	subwindow.
301		434
302	=back	435	=back
303		436
		437	=cut
		438
		439	package urxvt;
		440
		441	use utf8;
		442	use strict;
		443	use Carp ();
		444	use Scalar::Util ();
		445	use List::Util ();
		446
		447	our $VERSION = 1;
		448	our $TERM;
		449	our @HOOKNAME;
		450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		451	our %OPTION;
		452
		453	our $LIBDIR;
		454	our $RESNAME;
		455	our $RESCLASS;
		456	our $RXVTNAME;
		457
304	=head2 Variables in the C<urxvt> Package	458	=head2 Variables in the C<urxvt> Package
305		459
306	=over 4	460	=over 4
		461
		462	=item $urxvt::LIBDIR
		463
		464	The rxvt-unicode library directory, where, among other things, the perl
		465	modules and scripts are stored.
		466
		467	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		468
		469	The resource class and name rxvt-unicode uses to look up X resources.
		470
		471	=item $urxvt::RXVTNAME
		472
		473	The basename of the installed binaries, usually C<urxvt>.
307		474
308	=item $urxvt::TERM	475	=item $urxvt::TERM
309		476
310	The current terminal. This variable stores the current C<urxvt::term>	477	The current terminal. This variable stores the current C<urxvt::term>
311	object, whenever a callback/hook is executing.	478	object, whenever a callback/hook is executing.
…		…
313	=back	480	=back
314		481
315	=head2 Functions in the C<urxvt> Package	482	=head2 Functions in the C<urxvt> Package
316		483
317	=over 4	484	=over 4
318
319	=item $term = new urxvt [arg...]
320
321	Creates a new terminal, very similar as if you had started it with
322	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
323	if the new instance couldn't be created. Returns C<undef> if the new
324	instance didn't initialise perl, and the terminal object otherwise. The
325	C<init> and C<start> hooks will be called during the call.
326		485
327	=item urxvt::fatal $errormessage	486	=item urxvt::fatal $errormessage
328		487
329	Fatally aborts execution with the given error message. Avoid at all	488	Fatally aborts execution with the given error message. Avoid at all
330	costs! The only time this is acceptable is when the terminal process	489	costs! The only time this is acceptable is when the terminal process
…		…
337	that calls this function.	496	that calls this function.
338		497
339	Using this function has the advantage that its output ends up in the	498	Using this function has the advantage that its output ends up in the
340	correct place, e.g. on stderr of the connecting urxvtc client.	499	correct place, e.g. on stderr of the connecting urxvtc client.
341		500
		501	Messages have a size limit of 1023 bytes currently.
		502
342	=item $time = urxvt::NOW	503	=item $time = urxvt::NOW
343		504
344	Returns the "current time" (as per the event loop).	505	Returns the "current time" (as per the event loop).
345		506
346	=item urxvt::CurrentTime	507	=item urxvt::CurrentTime
347		508
348	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	509	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
349	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	510	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
350	Button4Mask, Button5Mask, AnyModifier	511	Button4Mask, Button5Mask, AnyModifier
		512
		513	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		514	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		515	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		516	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		517	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		518	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		519	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		520
		521	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		522	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		523	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		524	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		525	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		526	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		527	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
351		528
352	Various constants for use in X calls and event processing.	529	Various constants for use in X calls and event processing.
353		530
354	=back	531	=back
355		532
…		…
384		561
385	=item $background = urxvt::GET_BASEBG $rend	562	=item $background = urxvt::GET_BASEBG $rend
386		563
387	Return the foreground/background colour index, respectively.	564	Return the foreground/background colour index, respectively.
388		565
389	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	566	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
390		567
391	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	568	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
392		569
393	Replace the foreground/background colour in the rendition mask with the	570	Replace the foreground/background colour in the rendition mask with the
394	specified one.	571	specified one.
395		572
396	=item $value = urxvt::GET_CUSTOM ($rend)	573	=item $value = urxvt::GET_CUSTOM $rend
397		574
398	Return the "custom" value: Every rendition has 5 bits for use by	575	Return the "custom" value: Every rendition has 5 bits for use by
399	extensions. They can be set and changed as you like and are initially	576	extensions. They can be set and changed as you like and are initially
400	zero.	577	zero.
401		578
402	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	579	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
403		580
404	Change the custom value.	581	Change the custom value.
405		582
406	=back	583	=back
407		584
408	=cut	585	=cut
409
410	package urxvt;
411
412	use utf8;
413	use strict;
414	use Scalar::Util ();
415	use List::Util ();
416
417	our $VERSION = 1;
418	our $TERM;
419	our @HOOKNAME;
420	our %OPTION;
421	our $LIBDIR;
422		586
423	BEGIN {	587	BEGIN {
424	urxvt->bootstrap;	588	urxvt->bootstrap;
425		589
426	# overwrite perl's warn	590	# overwrite perl's warn
…		…
429	$msg .= "\n"	593	$msg .= "\n"
430	unless $msg =~ /\n$/;	594	unless $msg =~ /\n$/;
431	urxvt::warn ($msg);	595	urxvt::warn ($msg);
432	};	596	};
433		597
		598	# %ENV is the original startup environment
		599	delete $ENV{IFS};
		600	delete $ENV{CDPATH};
		601	delete $ENV{BASH_ENV};
434	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	602	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
435	delete $ENV{CDPATH};
436	}	603	}
437		604
438	my @hook_count;
439	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	605	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
440		606
441	sub verbose {	607	sub verbose {
442	my ($level, $msg) = @_;	608	my ($level, $msg) = @_;
443	warn "$msg\n" if $level <= $verbosity;	609	warn "$msg\n" if $level <= $verbosity;
444	}	610	}
445		611
446	# find on_xxx subs in the package and register them
447	# as hooks
448	sub register_package($) {
449	my ($pkg) = @_;
450
451	for my $htype (0.. $#HOOKNAME) {
452	my $name = $HOOKNAME[$htype];
453
454	my $ref = $pkg->can ("on_" . lc $name)
455	or next;
456
457	$TERM->{_hook}[$htype]{$pkg} = $ref;
458	$hook_count[$htype]++
459	or set_should_invoke $htype, 1;
460	}
461	}
462
463	my $extension_pkg = "extension0000";	612	my $extension_pkg = "extension0000";
464	my %extension_pkg;	613	my %extension_pkg;
465		614
466	# load a single script into its own package, once only	615	# load a single script into its own package, once only
467	sub extension_package($) {	616	sub extension_package($) {
…		…
473	verbose 3, "loading extension '$path' into package '$pkg'";	622	verbose 3, "loading extension '$path' into package '$pkg'";
474		623
475	open my $fh, "<:raw", $path	624	open my $fh, "<:raw", $path
476	or die "$path: $!";	625	or die "$path: $!";
477		626
		627	my $source =
478	my $source = untaint "package $pkg; use strict; use utf8;\n"	628	"package $pkg; use strict; use utf8;\n"
479	. "use base urxvt::term::proxy::;\n"	629	. "use base urxvt::term::extension::;\n"
480	. "#line 1 \"$path\"\n{\n"	630	. "#line 1 \"$path\"\n{\n"
481	. (do { local $/; <$fh> })	631	. (do { local $/; <$fh> })
482	. "\n};\n1";	632	. "\n};\n1";
483		633
		634	eval $source
484	eval $source or die "$path: $@";	635	or die "$path: $@";
485		636
486	$pkg	637	$pkg
487	}	638	}
488	}	639	}
489		640
…		…
495	my $htype = shift;	646	my $htype = shift;
496		647
497	if ($htype == 0) { # INIT	648	if ($htype == 0) { # INIT
498	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	649	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499		650
500	my %want_ext;	651	my %ext_arg;
501		652
502	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	653	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
503	if ($_ eq "default") {	654	if ($_ eq "default") {
504	$want_ext{$_}++ for qw(selection option-popup selection-popup);	655	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
505	} elsif (/^-(.*)$/) {	656	} elsif (/^-(.*)$/) {
506	delete $want_ext{$1};	657	delete $ext_arg{$1};
		658	} elsif (/^([^<]+)<(.*)>$/) {
		659	push @{ $ext_arg{$1} }, $2;
507	} else {	660	} else {
508	$want_ext{$_}++;	661	$ext_arg{$_} \|\|= [];
509	}	662	}
510	}	663	}
511		664
512	for my $ext (keys %want_ext) {	665	while (my ($ext, $argv) = each %ext_arg) {
513	my @files = grep -f $_, map "$_/$ext", @dirs;	666	my @files = grep -f $_, map "$_/$ext", @dirs;
514		667
515	if (@files) {	668	if (@files) {
516	register_package extension_package $files[0];	669	$TERM->register_package (extension_package $files[0], $argv);
517	} else {	670	} else {
518	warn "perl extension '$ext' not found in perl library search path\n";	671	warn "perl extension '$ext' not found in perl library search path\n";
519	}	672	}
520	}	673	}
521		674
…		…
530	if $verbosity >= 10;	683	if $verbosity >= 10;
531		684
532	keys %$cb;	685	keys %$cb;
533		686
534	while (my ($pkg, $cb) = each %$cb) {	687	while (my ($pkg, $cb) = each %$cb) {
535	eval {	688	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
536	$retval = $cb->(
537	$TERM->{_pkg}{$pkg} \|\|= do {
538	my $proxy = bless { }, $pkg;
539	Scalar::Util::weaken ($proxy->{term} = $TERM);
540	$proxy
541	},
542	@_,
543	) and last;	689	and last;
544	};	690
545	if ($@) {	691	if ($@) {
546	$TERM->ungrab; # better to lose the grab than the session	692	$TERM->ungrab; # better to lose the grab than the session
547	warn $@;	693	warn $@;
548	}	694	}
549	}	695	}
		696
		697	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		698	if $verbosity >= 11;
550	}	699	}
551		700
552	if ($htype == 1) { # DESTROY	701	if ($htype == 1) { # DESTROY
553	# remove hooks if unused
554	if (my $hook = $TERM->{_hook}) {
555	for my $htype (0..$#$hook) {
556	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
557	or set_should_invoke $htype, 0;
558	}
559	}
560
561	# clear package objects	702	# clear package objects
562	%$_ = () for values %{ $TERM->{_pkg} };	703	%$_ = () for values %{ $TERM->{_pkg} };
563		704
564	# clear package	705	# clear package
565	%$TERM = ();	706	%$TERM = ();
566	}	707	}
567		708
568	$retval	709	$retval
569	}	710	}
570		711
571	# urxvt::term::proxy	712	sub exec_async(@) {
		713	my $pid = fork;
572		714
573	sub urxvt::term::proxy::AUTOLOAD {	715	return
574	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	716	if !defined $pid or $pid;
		717
		718	%ENV = %{ $TERM->env };
		719
		720	exec @_;
		721	_exit 255;
		722	}
		723
		724	# urxvt::term::extension
		725
		726	package urxvt::term::extension;
		727
		728	sub enable {
		729	my ($self, %hook) = @_;
		730	my $pkg = $self->{_pkg};
		731
		732	while (my ($name, $cb) = each %hook) {
		733	my $htype = $HOOKTYPE{uc $name};
		734	defined $htype
		735	or Carp::croak "unsupported hook type '$name'";
		736
		737	$self->set_should_invoke ($htype, +1)
		738	unless exists $self->{term}{_hook}[$htype]{$pkg};
		739
		740	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		741	}
		742	}
		743
		744	sub disable {
		745	my ($self, @hook) = @_;
		746	my $pkg = $self->{_pkg};
		747
		748	for my $name (@hook) {
		749	my $htype = $HOOKTYPE{uc $name};
		750	defined $htype
		751	or Carp::croak "unsupported hook type '$name'";
		752
		753	$self->set_should_invoke ($htype, -1)
		754	if delete $self->{term}{_hook}[$htype]{$pkg};
		755	}
		756	}
		757
		758	our $AUTOLOAD;
		759
		760	sub AUTOLOAD {
		761	$AUTOLOAD =~ /:([^:]+)$/
575	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	762	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
576		763
577	eval qq{	764	eval qq{
578	sub $urxvt::term::proxy::AUTOLOAD {	765	sub $AUTOLOAD {
579	my \$proxy = shift;	766	my \$proxy = shift;
580	\$proxy->{term}->$1 (\@_)	767	\$proxy->{term}->$1 (\@_)
581	}	768	}
582	1	769	1
583	} or die "FATAL: unable to compile method forwarder: $@";	770	} or die "FATAL: unable to compile method forwarder: $@";
584		771
585	goto &$urxvt::term::proxy::AUTOLOAD;	772	goto &$AUTOLOAD;
586	}	773	}
587		774
588	sub urxvt::term::proxy::DESTROY {	775	sub DESTROY {
589	# nop	776	# nop
590	}	777	}
591		778
592	# urxvt::destroy_hook	779	# urxvt::destroy_hook
593		780
…		…
603		790
604	=head2 The C<urxvt::anyevent> Class	791	=head2 The C<urxvt::anyevent> Class
605		792
606	The sole purpose of this class is to deliver an interface to the	793	The sole purpose of this class is to deliver an interface to the
607	C<AnyEvent> module - any module using it will work inside urxvt without	794	C<AnyEvent> module - any module using it will work inside urxvt without
608	further work. The only exception is that you cannot wait on condition	795	further programming. The only exception is that you cannot wait on
609	variables, but non-blocking condvar use is ok. What this means is that you	796	condition variables, but non-blocking condvar use is ok. What this means
610	cannot use blocking APIs, but the non-blocking variant should work.	797	is that you cannot use blocking APIs, but the non-blocking variant should
		798	work.
611		799
612	=cut	800	=cut
613		801
614	our $VERSION = 1;	802	our $VERSION = 1;
615		803
…		…
660	${$_[0]}++;	848	${$_[0]}++;
661	}	849	}
662		850
663	sub urxvt::anyevent::condvar::wait {	851	sub urxvt::anyevent::condvar::wait {
664	unless (${$_[0]}) {	852	unless (${$_[0]}) {
665	require Carp;
666	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	853	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
667	}	854	}
668	}	855	}
669		856
670	package urxvt::term;	857	package urxvt::term;
671		858
672	=head2 The C<urxvt::term> Class	859	=head2 The C<urxvt::term> Class
673		860
674	=over 4	861	=over 4
675		862
		863	=cut
		864
		865	# find on_xxx subs in the package and register them
		866	# as hooks
		867	sub register_package {
		868	my ($self, $pkg, $argv) = @_;
		869
		870	my $proxy = bless {
		871	_pkg => $pkg,
		872	argv => $argv,
		873	}, $pkg;
		874	Scalar::Util::weaken ($proxy->{term} = $self);
		875
		876	$self->{_pkg}{$pkg} = $proxy;
		877
		878	for my $name (@HOOKNAME) {
		879	if (my $ref = $pkg->can ("on_" . lc $name)) {
		880	$proxy->enable ($name => $ref);
		881	}
		882	}
		883	}
		884
		885	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		886
		887	Creates a new terminal, very similar as if you had started it with system
		888	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		889	hash which defines the environment of the new terminal.
		890
		891	Croaks (and probably outputs an error message) if the new instance
		892	couldn't be created. Returns C<undef> if the new instance didn't
		893	initialise perl, and the terminal object otherwise. The C<init> and
		894	C<start> hooks will be called during this call.
		895
		896	=cut
		897
		898	sub new {
		899	my ($class, $env, @args) = @_;
		900
		901	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		902	}
		903
676	=item $term->destroy	904	=item $term->destroy
677		905
678	Destroy the terminal object (close the window, free resources etc.).	906	Destroy the terminal object (close the window, free resources
		907	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		908	watchers (timers, io watchers) are still active.
679		909
680	=item $isset = $term->option ($optval[, $set])	910	=item $isset = $term->option ($optval[, $set])
681		911
682	Returns true if the option specified by C<$optval> is enabled, and	912	Returns true if the option specified by C<$optval> is enabled, and
683	optionally change it. All option values are stored by name in the hash	913	optionally change it. All option values are stored by name in the hash
…		…
733	my ($self, $name) = (shift, shift);	963	my ($self, $name) = (shift, shift);
734	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	964	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
735	&urxvt::term::_resource	965	&urxvt::term::_resource
736	}	966	}
737		967
		968	=item $value = $term->x_resource ($pattern)
		969
		970	Returns the X-Resource for the given pattern, excluding the program or
		971	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		972	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		973	resource with that pattern exists.
		974
		975	This method should only be called during the C<on_start> hook, as there is
		976	only one resource database per display, and later invocations might return
		977	the wrong resources.
		978
		979	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		980
		981	Adds a keymap translation exactly as specified via a resource. See the
		982	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		983
738	=item $rend = $term->rstyle ([$new_rstyle])	984	=item $rend = $term->rstyle ([$new_rstyle])
739		985
740	Return and optionally change the current rendition. Text that is output by	986	Return and optionally change the current rendition. Text that is output by
741	the terminal application will use this style.	987	the terminal application will use this style.
742		988
…		…
752	=item ($row, $col) = $term->selection_end ([$row, $col])	998	=item ($row, $col) = $term->selection_end ([$row, $col])
753		999
754	Return the current values of the selection mark, begin or end positions,	1000	Return the current values of the selection mark, begin or end positions,
755	and optionally set them to new values.	1001	and optionally set them to new values.
756		1002
		1003	=item $term->selection_make ($eventtime[, $rectangular])
		1004
		1005	Tries to make a selection as set by C<selection_beg> and
		1006	C<selection_end>. If C<$rectangular> is true (default: false), a
		1007	rectangular selection will be made. This is the prefered function to make
		1008	a selection.
		1009
757	=item $success = $term->selection_grab ($eventtime)	1010	=item $success = $term->selection_grab ($eventtime)
758		1011
759	Try to request the primary selection from the server (for example, as set	1012	Try to request the primary selection text from the server (for example, as
760	by the next method).	1013	set by the next method). No visual feedback will be given. This function
		1014	is mostly useful from within C<on_sel_grab> hooks.
761		1015
762	=item $oldtext = $term->selection ([$newtext])	1016	=item $oldtext = $term->selection ([$newtext])
763		1017
764	Return the current selection text and optionally replace it by C<$newtext>.	1018	Return the current selection text and optionally replace it by C<$newtext>.
765		1019
766	#=item $term->overlay ($x, $y, $text)	1020	=item $term->overlay_simple ($x, $y, $text)
767	#	1021
768	#Create a simple multi-line overlay box. See the next method for details.	1022	Create a simple multi-line overlay box. See the next method for details.
769	#	1023
770	#=cut	1024	=cut
771	#	1025
772	#sub urxvt::term::scr_overlay {	1026	sub overlay_simple {
773	# my ($self, $x, $y, $text) = @_;	1027	my ($self, $x, $y, $text) = @_;
774	#	1028
775	# my @lines = split /\n/, $text;	1029	my @lines = split /\n/, $text;
776	#	1030
777	# my $w = 0;	1031	my $w = List::Util::max map $self->strwidth ($_), @lines;
778	# for (map $self->strwidth ($_), @lines) {	1032
779	# $w = $_ if $w < $_;
780	# }
781	#
782	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1033	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
783	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1034	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
784	#}	1035
		1036	$overlay
		1037	}
785		1038
786	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1039	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
787		1040
788	Create a new (empty) overlay at the given position with the given	1041	Create a new (empty) overlay at the given position with the given
789	width/height. C<$rstyle> defines the initial rendition style	1042	width/height. C<$rstyle> defines the initial rendition style
…		…
856		1109
857	=item $string = $term->locale_decode ($octets)	1110	=item $string = $term->locale_decode ($octets)
858		1111
859	Convert the given locale-encoded octets into a perl string.	1112	Convert the given locale-encoded octets into a perl string.
860		1113
		1114	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1115
		1116	XORs the rendition values in the given span with the provided value
		1117	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1118	refresh hooks to provide effects similar to the selection.
		1119
		1120	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1121
		1122	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1123	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1124	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1125	it instead. Both styles I<MUST NOT> contain font styles.
		1126
		1127	=item $term->scr_bell
		1128
		1129	Ring the bell!
		1130
861	=item $term->scr_add_lines ($string)	1131	=item $term->scr_add_lines ($string)
862		1132
863	Write the given text string to the screen, as if output by the application	1133	Write the given text string to the screen, as if output by the application
864	running inside the terminal. It may not contain command sequences (escape	1134	running inside the terminal. It may not contain command sequences (escape
865	codes), but is free to use line feeds, carriage returns and tabs. The	1135	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
879		1149
880	Write the octets given in C<$data> to the tty (i.e. as program input). To	1150	Write the octets given in C<$data> to the tty (i.e. as program input). To
881	pass characters instead of octets, you should convert your strings first	1151	pass characters instead of octets, you should convert your strings first
882	to the locale-specific encoding using C<< $term->locale_encode >>.	1152	to the locale-specific encoding using C<< $term->locale_encode >>.
883		1153
		1154	=item $old_events = $term->pty_ev_events ([$new_events])
		1155
		1156	Replaces the event mask of the pty watcher by the given event mask. Can
		1157	be used to suppress input and output handling to the pty/tty. See the
		1158	description of C<< urxvt::timer->events >>. Make sure to always restore
		1159	the previous value.
		1160
884	=item $windowid = $term->parent	1161	=item $windowid = $term->parent
885		1162
886	Return the window id of the toplevel window.	1163	Return the window id of the toplevel window.
887		1164
888	=item $windowid = $term->vt	1165	=item $windowid = $term->vt
889		1166
890	Return the window id of the terminal window.	1167	Return the window id of the terminal window.
891		1168
		1169	=item $term->vt_emask_add ($x_event_mask)
		1170
		1171	Adds the specified events to the vt event mask. Useful e.g. when you want
		1172	to receive pointer events all the times:
		1173
		1174	$term->vt_emask_add (urxvt::PointerMotionMask);
		1175
892	=item $window_width = $term->width	1176	=item $window_width = $term->width
893		1177
894	=item $window_height = $term->height	1178	=item $window_height = $term->height
895		1179
896	=item $font_width = $term->fwidth	1180	=item $font_width = $term->fwidth
…		…
909		1193
910	=item $max_scrollback = $term->saveLines	1194	=item $max_scrollback = $term->saveLines
911		1195
912	=item $nrow_plus_saveLines = $term->total_rows	1196	=item $nrow_plus_saveLines = $term->total_rows
913		1197
914	=item $lines_in_scrollback = $term->nsaved	1198	=item $topmost_scrollback_row = $term->top_row
915		1199
916	Return various integers describing terminal characteristics.	1200	Return various integers describing terminal characteristics.
		1201
		1202	=item $x_display = $term->display_id
		1203
		1204	Return the DISPLAY used by rxvt-unicode.
		1205
		1206	=item $lc_ctype = $term->locale
		1207
		1208	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1209
		1210	=item $env = $term->env
		1211
		1212	Returns a copy of the environment in effect for the terminal as a hashref
		1213	similar to C<\%ENV>.
		1214
		1215	=cut
		1216
		1217	sub env {
		1218	if (my $env = $_[0]->_env) {
		1219	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1220	} else {
		1221	+{ %ENV }
		1222	}
		1223	}
917		1224
918	=item $modifiermask = $term->ModLevel3Mask	1225	=item $modifiermask = $term->ModLevel3Mask
919		1226
920	=item $modifiermask = $term->ModMetaMask	1227	=item $modifiermask = $term->ModMetaMask
921		1228
…		…
924	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1231	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
925	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1232	AltGr), the meta key (often Alt) and the num lock key, if applicable.
926		1233
927	=item $view_start = $term->view_start ([$newvalue])	1234	=item $view_start = $term->view_start ([$newvalue])
928		1235
929	Returns the negative row number of the topmost line. Minimum value is	1236	Returns the row number of the topmost displayed line. Maximum value is
930	C<0>, which displays the normal terminal contents. Larger values scroll	1237	C<0>, which displays the normal terminal contents. Lower values scroll
931	this many lines into the scrollback buffer.	1238	this many lines into the scrollback buffer.
932		1239
933	=item $term->want_refresh	1240	=item $term->want_refresh
934		1241
935	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1242	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1014	Return the row number of the first/last row of the line, respectively.	1321	Return the row number of the first/last row of the line, respectively.
1015		1322
1016	=item $offset = $line->offset_of ($row, $col)	1323	=item $offset = $line->offset_of ($row, $col)
1017		1324
1018	Returns the character offset of the given row\|col pair within the logical	1325	Returns the character offset of the given row\|col pair within the logical
1019	line.	1326	line. Works for rows outside the line, too, and returns corresponding
		1327	offsets outside the string.
1020		1328
1021	=item ($row, $col) = $line->coord_of ($offset)	1329	=item ($row, $col) = $line->coord_of ($offset)
1022		1330
1023	Translates a string offset into terminal coordinates again.	1331	Translates a string offset into terminal coordinates again.
1024		1332
…		…
1098	$offset / $self->{ncol} + $self->{beg},	1406	$offset / $self->{ncol} + $self->{beg},
1099	$offset % $self->{ncol}	1407	$offset % $self->{ncol}
1100	)	1408	)
1101	}	1409	}
1102		1410
1103	=item ($row, $col) = $line->coord_of ($offset)
1104	=item $text = $term->special_encode $string	1411	=item $text = $term->special_encode $string
1105		1412
1106	Converts a perl string into the special encoding used by rxvt-unicode,	1413	Converts a perl string into the special encoding used by rxvt-unicode,
1107	where one character corresponds to one screen cell. See	1414	where one character corresponds to one screen cell. See
1108	C<< $term->ROW_t >> for details.	1415	C<< $term->ROW_t >> for details.
…		…
1110	=item $string = $term->special_decode $text	1417	=item $string = $term->special_decode $text
1111		1418
1112	Converts rxvt-unicodes text reprsentation into a perl string. See	1419	Converts rxvt-unicodes text reprsentation into a perl string. See
1113	C<< $term->ROW_t >> for details.	1420	C<< $term->ROW_t >> for details.
1114		1421
		1422	=item $success = $term->grab_button ($button, $modifiermask)
		1423
		1424	Registers a synchronous button grab. See the XGrabButton manpage.
		1425
		1426	=item $success = $term->grab ($eventtime[, $sync])
		1427
		1428	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1429	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1430
		1431	=item $term->allow_events_async
		1432
		1433	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1434
		1435	=item $term->allow_events_sync
		1436
		1437	Calls XAllowEvents with SyncBoth for the most recent grab.
		1438
		1439	=item $term->allow_events_replay
		1440
		1441	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1442	recent grab.
		1443
		1444	=item $term->ungrab
		1445
		1446	Calls XUngrab for the most recent grab. Is called automatically on
		1447	evaluation errors, as it is better to lose the grab in the error case as
		1448	the session.
		1449
1115	=back	1450	=back
1116		1451
1117	=cut	1452	=cut
1118		1453
1119	package urxvt::popup;	1454	package urxvt::popup;
…		…
1134	$item->{render} \|\|= sub { $_[0]{text} };	1469	$item->{render} \|\|= sub { $_[0]{text} };
1135		1470
1136	push @{ $self->{item} }, $item;	1471	push @{ $self->{item} }, $item;
1137	}	1472	}
1138		1473
1139	sub add_separator {	1474	=item $popup->add_title ($title)
1140	my ($self, $sep) = @_;
1141		1475
1142	$sep \|\|= "═";	1476	Adds a non-clickable title to the popup.
1143		1477
1144	$self->add_item ({	1478	=cut
1145	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1146	text => "",
1147	render => sub { $sep x $urxvt::TERM->ncol },
1148	activate => sub { },
1149	});
1150	}
1151		1479
1152	sub add_title {	1480	sub add_title {
1153	my ($self, $title) = @_;	1481	my ($self, $title) = @_;
1154		1482
1155	$self->add_item ({	1483	$self->add_item ({
…		…
1157	text => $title,	1485	text => $title,
1158	activate => sub { },	1486	activate => sub { },
1159	});	1487	});
1160	}	1488	}
1161		1489
		1490	=item $popup->add_separator ([$sepchr])
		1491
		1492	Creates a separator, optionally using the character given as C<$sepchr>.
		1493
		1494	=cut
		1495
		1496	sub add_separator {
		1497	my ($self, $sep) = @_;
		1498
		1499	$sep \|\|= "=";
		1500
		1501	$self->add_item ({
		1502	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1503	text => "",
		1504	render => sub { $sep x $self->{term}->ncol },
		1505	activate => sub { },
		1506	});
		1507	}
		1508
		1509	=item $popup->add_button ($text, $cb)
		1510
		1511	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1512	selected.
		1513
		1514	=cut
		1515
1162	sub add_button {	1516	sub add_button {
1163	my ($self, $text, $cb) = @_;	1517	my ($self, $text, $cb) = @_;
1164		1518
1165	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1519	$self->add_item ({ type => "button", text => $text, activate => $cb});
1166	}	1520	}
		1521
		1522	=item $popup->add_toggle ($text, $cb, $initial_value)
		1523
		1524	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1525	whenever it gets toggled, with a boolean indicating its value as its first
		1526	argument.
		1527
		1528	=cut
1167		1529
1168	sub add_toggle {	1530	sub add_toggle {
1169	my ($self, $text, $cb, $value) = @_;	1531	my ($self, $text, $cb, $value) = @_;
1170		1532
1171	my $item; $item = {	1533	my $item; $item = {
1172	type => "button",	1534	type => "button",
1173	text => " $text",	1535	text => " $text",
1174	value => $value,	1536	value => $value,
1175	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1537	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1176	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1538	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1177	};	1539	};
1178		1540
1179	$self->add_item ($item);	1541	$self->add_item ($item);
1180	}	1542	}
		1543
		1544	=item $popup->show
		1545
		1546	Displays the popup (which is initially hidden).
		1547
		1548	=cut
1181		1549
1182	sub show {	1550	sub show {
1183	my ($self) = @_;	1551	my ($self) = @_;
1184		1552
1185	local $urxvt::popup::self = $self;	1553	local $urxvt::popup::self = $self;
1186		1554
		1555	my $env = $self->{term}->env;
		1556	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1557	delete $env->{LC_ALL};
		1558	$env->{LC_CTYPE} = $self->{term}->locale;
		1559
		1560	urxvt::term->new ($env, $self->{term}->resource ("name"),
1187	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1561	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1188	"--transient-for" => $self->{term}->parent,	1562	"--transient-for" => $self->{term}->parent,
		1563	"-display" => $self->{term}->display_id,
1189	"-pe" => "urxvt-popup")	1564	"-pe" => "urxvt-popup")
1190	or die "unable to create popup window\n";	1565	or die "unable to create popup window\n";
1191	}	1566	}
1192		1567
1193	sub DESTROY {	1568	sub DESTROY {
1194	my ($self) = @_;	1569	my ($self) = @_;
1195		1570
1196	delete $self->{term}{_destroy}{$self};	1571	delete $self->{term}{_destroy}{$self};
1197	$self->{term}->ungrab;	1572	$self->{term}->ungrab;
1198	}	1573	}
		1574
		1575	=back
1199		1576
1200	=head2 The C<urxvt::timer> Class	1577	=head2 The C<urxvt::timer> Class
1201		1578
1202	This class implements timer watchers/events. Time is represented as a	1579	This class implements timer watchers/events. Time is represented as a
1203	fractional number of seconds since the epoch. Example:	1580	fractional number of seconds since the epoch. Example:
…		…
1256		1633
1257	$term->{socket} = ...	1634	$term->{socket} = ...
1258	$term->{iow} = urxvt::iow	1635	$term->{iow} = urxvt::iow
1259	->new	1636	->new
1260	->fd (fileno $term->{socket})	1637	->fd (fileno $term->{socket})
1261	->events (1) # wait for read data	1638	->events (urxvt::EVENT_READ)
1262	->start	1639	->start
1263	->cb (sub {	1640	->cb (sub {
1264	my ($iow, $revents) = @_;	1641	my ($iow, $revents) = @_;
1265	# $revents must be 1 here, no need to check	1642	# $revents must be 1 here, no need to check
1266	sysread $term->{socket}, my $buf, 8192	1643	sysread $term->{socket}, my $buf, 8192
…		…
1283		1660
1284	Set the filedescriptor (not handle) to watch.	1661	Set the filedescriptor (not handle) to watch.
1285		1662
1286	=item $iow = $iow->events ($eventmask)	1663	=item $iow = $iow->events ($eventmask)
1287		1664
1288	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1665	Set the event mask to watch. The only allowed values are
1289	data, Bit #1 (value C<2>) enables watching for write data.	1666	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1667	together, or C<urxvt::EVENT_NONE>.
1290		1668
1291	=item $iow = $iow->start	1669	=item $iow = $iow->start
1292		1670
1293	Start watching for requested events on the given handle.	1671	Start watching for requested events on the given handle.
1294		1672
…		…
1309		1687
1310	=item == 0 - fatal messages	1688	=item == 0 - fatal messages
1311		1689
1312	=item >= 3 - script loading and management	1690	=item >= 3 - script loading and management
1313		1691
1314	=item >=10 - all events received	1692	=item >=10 - all called hooks
		1693
		1694	=item >=11 - hook reutrn values
1315		1695
1316	=back	1696	=back
1317		1697
1318	=head1 AUTHOR	1698	=head1 AUTHOR
1319		1699

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.59 by root, Mon Jan 9 00:34:36 2006 UTC vs. Revision 1.97 by elmex, Tue Jan 17 16:53:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.59 by root, Mon Jan 9 00:34:36 2006 UTC vs.
Revision 1.97 by elmex, Tue Jan 17 16:53:47 2006 UTC