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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.62 by root, Mon Jan 9 02:06:43 2006 UTC vs.
Revision 1.96 by root, Tue Jan 17 16:22:41 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
55	Rot-13 the selection when activated. Used via keyboard trigger:	77	Rot-13 the selection when activated. Used via keyboard trigger:
56		78
57	URxvt.keysym.C-M-r: perl:selection:rot13	79	URxvt.keysym.C-M-r: perl:selection:rot13
		80
		81	=item remote-pastebin
		82
		83	Upload the selection as textfile to a remote site.
		84
		85	URxvt.keysym.C-M-e: perl:selection:remote-pastebin
		86
		87	To set the command to upload the file set this resource:
		88
		89	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		90
		91	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
		92	md5 sum of the selection.
		93	After an successful upload the selection will be replaced by the following url
		94	(the % is the placeholder for the filename):
		95
		96	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
58		97
59	=back	98	=back
60		99
61	=item option-popup (enabled by default)	100	=item option-popup (enabled by default)
62		101
…		…
64	runtime.	103	runtime.
65		104
66	=item selection-popup (enabled by default)	105	=item selection-popup (enabled by default)
67		106
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	107	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	108	text into various other formats/action (such as uri unescaping, perl
		109	evalution, web-browser starting etc.), depending on content.
70		110
71	=item digital-clock	111	=item searchable-scrollback<hotkey> (enabled by default)
72		112
73	Displays a digital clock using the built-in overlay.	113	Adds regex search functionality to the scrollback buffer, triggered
		114	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		115	input/output is suspended and a regex is displayed at the bottom of the
		116	screen.
		117
		118	Inputting characters appends them to the regex and continues incremental
		119	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		120	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		121	bottom. C<Escape> leaves search mode and returns to the point where search
		122	was started, while C<Enter> or C<Return> stay at the current position and
		123	additionally stores the first match in the current line into the primary
		124	selection.
		125
		126	=item selection-autotransform
		127
		128	This selection allows you to do automatic transforms on a selection
		129	whenever a selection is made.
		130
		131	It works by specifying perl snippets (most useful is a single C<s///>
		132	operator) that modify C<$_> as resources:
		133
		134	URxvt.selection-autotransform.0: transform
		135	URxvt.selection-autotransform.1: transform
		136	...
		137
		138	For example, the following will transform selections of the form
		139	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		140	$word>:
		141
		142	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		143
		144	And this example matches the same,but replaces it with vi-commands you can
		145	paste directly into your (vi :) editor:
		146
		147	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		148
		149	Of course, this can be modified to suit your needs and your editor :)
		150
		151	To expand the example above to typical perl error messages ("XXX at
		152	FILENAME line YYY."), you need a slightly more elaborate solution:
		153
		154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		155	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		156
		157	The first line tells the selection code to treat the unchanging part of
		158	every error message as a selection pattern, and the second line transforms
		159	the message into vi commands to load the file.
74		160
75	=item mark-urls	161	=item mark-urls
76		162
77	Uses per-line display filtering (C<on_line_update>) to underline urls.	163	Uses per-line display filtering (C<on_line_update>) to underline urls and
		164	make them clickable. When middle-clicked, the program specified in the
		165	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		166	the URL as first argument.
78		167
79	=item block-graphics-to-ascii	168	=item block-graphics-to-ascii
80		169
81	A not very useful example of filtering all text output to the terminal,	170	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	171	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.	172	similar-looking ascii character.
84		173
		174	=item digital-clock
		175
		176	Displays a digital clock using the built-in overlay.
		177
85	=item example-refresh-hooks	178	=item example-refresh-hooks
86		179
87	Displays a very simple digital clock in the upper right corner of the	180	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	181	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	182	overlays or changes.
90		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
…		…
226	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
227	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
228	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
229	output.	355	output.
230		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
231	=item on_line_update $term, $row	362	=item on_line_update $term, $row
232		363
233	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
234	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
235	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,
…		…
257		388
258	Called whenever the user presses a key combination that has a	389	Called whenever the user presses a key combination that has a
259	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>
260	resource in the @@RXVT_NAME@@(1) manpage).	391	resource in the @@RXVT_NAME@@(1) manpage).
261		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
262	=item on_focus_in $term	399	=item on_focus_in $term
263		400
264	Called whenever the window gets the keyboard focus, before rxvt-unicode	401	Called whenever the window gets the keyboard focus, before rxvt-unicode
265	does focus in processing.	402	does focus in processing.
266		403
267	=item on_focus_out $term	404	=item on_focus_out $term
268		405
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	406	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	407	focus out processing.
271		408
272	=item on_key_press $term, $event, $octets	409	=item on_key_press $term, $event, $keysym, $octets
273		410
274	=item on_key_release $term, $event	411	=item on_key_release $term, $event, $keysym
275		412
276	=item on_button_press $term, $event	413	=item on_button_press $term, $event
277		414
278	=item on_button_release $term, $event	415	=item on_button_release $term, $event
279		416
…		…
295		432
296	subwindow.	433	subwindow.
297		434
298	=back	435	=back
299		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
300	=head2 Variables in the C<urxvt> Package	458	=head2 Variables in the C<urxvt> Package
301		459
302	=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>.
303		474
304	=item $urxvt::TERM	475	=item $urxvt::TERM
305		476
306	The current terminal. This variable stores the current C<urxvt::term>	477	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	478	object, whenever a callback/hook is executing.
…		…
309	=back	480	=back
310		481
311	=head2 Functions in the C<urxvt> Package	482	=head2 Functions in the C<urxvt> Package
312		483
313	=over 4	484	=over 4
314
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322		485
323	=item urxvt::fatal $errormessage	486	=item urxvt::fatal $errormessage
324		487
325	Fatally aborts execution with the given error message. Avoid at all	488	Fatally aborts execution with the given error message. Avoid at all
326	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
…		…
333	that calls this function.	496	that calls this function.
334		497
335	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
336	correct place, e.g. on stderr of the connecting urxvtc client.	499	correct place, e.g. on stderr of the connecting urxvtc client.
337		500
338	=item $is_safe = urxvt::safe	501	Messages have a size limit of 1023 bytes currently.
339
340	Returns true when it is safe to do potentially unsafe things, such as
341	evaluating perl code specified by the user. This is true when urxvt was
342	started setuid or setgid.
343		502
344	=item $time = urxvt::NOW	503	=item $time = urxvt::NOW
345		504
346	Returns the "current time" (as per the event loop).	505	Returns the "current time" (as per the event loop).
347		506
348	=item urxvt::CurrentTime	507	=item urxvt::CurrentTime
349		508
350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	509	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	510	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
352	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
353		528
354	Various constants for use in X calls and event processing.	529	Various constants for use in X calls and event processing.
355		530
356	=back	531	=back
357		532
…		…
386		561
387	=item $background = urxvt::GET_BASEBG $rend	562	=item $background = urxvt::GET_BASEBG $rend
388		563
389	Return the foreground/background colour index, respectively.	564	Return the foreground/background colour index, respectively.
390		565
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	566	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		567
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	568	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
394		569
395	Replace the foreground/background colour in the rendition mask with the	570	Replace the foreground/background colour in the rendition mask with the
396	specified one.	571	specified one.
397		572
398	=item $value = urxvt::GET_CUSTOM ($rend)	573	=item $value = urxvt::GET_CUSTOM $rend
399		574
400	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
401	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
402	zero.	577	zero.
403		578
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	579	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		580
406	Change the custom value.	581	Change the custom value.
407		582
408	=back	583	=back
409		584
410	=cut	585	=cut
411
412	package urxvt;
413
414	use utf8;
415	use strict;
416	use Scalar::Util ();
417	use List::Util ();
418
419	our $VERSION = 1;
420	our $TERM;
421	our @HOOKNAME;
422	our %OPTION;
423	our $LIBDIR;
424		586
425	BEGIN {	587	BEGIN {
426	urxvt->bootstrap;	588	urxvt->bootstrap;
427		589
428	# overwrite perl's warn	590	# overwrite perl's warn
…		…
431	$msg .= "\n"	593	$msg .= "\n"
432	unless $msg =~ /\n$/;	594	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	595	urxvt::warn ($msg);
434	};	596	};
435		597
		598	# %ENV is the original startup environment
436	delete $ENV{IFS};	599	delete $ENV{IFS};
437	delete $ENV{CDPATH};	600	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};	601	delete $ENV{BASH_ENV};
439	$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";
440	}	603	}
441		604
442	my @hook_count;
443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	605	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
444		606
445	sub verbose {	607	sub verbose {
446	my ($level, $msg) = @_;	608	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	609	warn "$msg\n" if $level <= $verbosity;
448	}	610	}
449		611
450	# find on_xxx subs in the package and register them
451	# as hooks
452	sub register_package($) {
453	my ($pkg) = @_;
454
455	for my $htype (0.. $#HOOKNAME) {
456	my $name = $HOOKNAME[$htype];
457
458	my $ref = $pkg->can ("on_" . lc $name)
459	or next;
460
461	$TERM->{_hook}[$htype]{$pkg} = $ref;
462	$hook_count[$htype]++
463	or set_should_invoke $htype, 1;
464	}
465	}
466
467	my $extension_pkg = "extension0000";	612	my $extension_pkg = "extension0000";
468	my %extension_pkg;	613	my %extension_pkg;
469		614
470	# load a single script into its own package, once only	615	# load a single script into its own package, once only
471	sub extension_package($) {	616	sub extension_package($) {
…		…
477	verbose 3, "loading extension '$path' into package '$pkg'";	622	verbose 3, "loading extension '$path' into package '$pkg'";
478		623
479	open my $fh, "<:raw", $path	624	open my $fh, "<:raw", $path
480	or die "$path: $!";	625	or die "$path: $!";
481		626
		627	my $source =
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	628	"package $pkg; use strict; use utf8;\n"
483	. "use base urxvt::term::proxy::;\n"	629	. "use base urxvt::term::extension::;\n"
484	. "#line 1 \"$path\"\n{\n"	630	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	631	. (do { local $/; <$fh> })
486	. "\n};\n1";	632	. "\n};\n1";
487		633
		634	eval $source
488	eval $source or die "$path: $@";	635	or die "$path: $@";
489		636
490	$pkg	637	$pkg
491	}	638	}
492	}	639	}
493		640
…		…
499	my $htype = shift;	646	my $htype = shift;
500		647
501	if ($htype == 0) { # INIT	648	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	649	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503		650
504	my %want_ext;	651	my %ext_arg;
505		652
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	653	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	654	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	655	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
509	} elsif (/^-(.*)$/) {	656	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	657	delete $ext_arg{$1};
		658	} elsif (/^([^<]+)<(.*)>$/) {
		659	push @{ $ext_arg{$1} }, $2;
511	} else {	660	} else {
512	$want_ext{$_}++;	661	$ext_arg{$_} \|\|= [];
513	}	662	}
514	}	663	}
515		664
516	for my $ext (keys %want_ext) {	665	while (my ($ext, $argv) = each %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	666	my @files = grep -f $_, map "$_/$ext", @dirs;
518		667
519	if (@files) {	668	if (@files) {
520	register_package extension_package $files[0];	669	$TERM->register_package (extension_package $files[0], $argv);
521	} else {	670	} else {
522	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";
523	}	672	}
524	}	673	}
525		674
…		…
534	if $verbosity >= 10;	683	if $verbosity >= 10;
535		684
536	keys %$cb;	685	keys %$cb;
537		686
538	while (my ($pkg, $cb) = each %$cb) {	687	while (my ($pkg, $cb) = each %$cb) {
539	eval {	688	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
540	$retval = $cb->(
541	$TERM->{_pkg}{$pkg} \|\|= do {
542	my $proxy = bless { }, $pkg;
543	Scalar::Util::weaken ($proxy->{term} = $TERM);
544	$proxy
545	},
546	@_,
547	) and last;	689	and last;
548	};	690
549	if ($@) {	691	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	692	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	693	warn $@;
552	}	694	}
553	}	695	}
		696
		697	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		698	if $verbosity >= 11;
554	}	699	}
555		700
556	if ($htype == 1) { # DESTROY	701	if ($htype == 1) { # DESTROY
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
561	or set_should_invoke $htype, 0;
562	}
563	}
564
565	# clear package objects	702	# clear package objects
566	%$_ = () for values %{ $TERM->{_pkg} };	703	%$_ = () for values %{ $TERM->{_pkg} };
567		704
568	# clear package	705	# clear package
569	%$TERM = ();	706	%$TERM = ();
570	}	707	}
571		708
572	$retval	709	$retval
573	}	710	}
574		711
575	# urxvt::term::proxy	712	sub exec_async(@) {
		713	my $pid = fork;
576		714
577	sub urxvt::term::proxy::AUTOLOAD {	715	return
578	$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 =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	762	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		763
581	eval qq{	764	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	765	sub $AUTOLOAD {
583	my \$proxy = shift;	766	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	767	\$proxy->{term}->$1 (\@_)
585	}	768	}
586	1	769	1
587	} or die "FATAL: unable to compile method forwarder: $@";	770	} or die "FATAL: unable to compile method forwarder: $@";
588		771
589	goto &$urxvt::term::proxy::AUTOLOAD;	772	goto &$AUTOLOAD;
590	}	773	}
591		774
592	sub urxvt::term::proxy::DESTROY {	775	sub DESTROY {
593	# nop	776	# nop
594	}	777	}
595		778
596	# urxvt::destroy_hook	779	# urxvt::destroy_hook
597		780
…		…
607		790
608	=head2 The C<urxvt::anyevent> Class	791	=head2 The C<urxvt::anyevent> Class
609		792
610	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
611	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
612	further work. The only exception is that you cannot wait on condition	795	further programming. The only exception is that you cannot wait on
613	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
614	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.
615		799
616	=cut	800	=cut
617		801
618	our $VERSION = 1;	802	our $VERSION = 1;
619		803
…		…
664	${$_[0]}++;	848	${$_[0]}++;
665	}	849	}
666		850
667	sub urxvt::anyevent::condvar::wait {	851	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {	852	unless (${$_[0]}) {
669	require Carp;
670	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";
671	}	854	}
672	}	855	}
673		856
674	package urxvt::term;	857	package urxvt::term;
675		858
676	=head2 The C<urxvt::term> Class	859	=head2 The C<urxvt::term> Class
677		860
678	=over 4	861	=over 4
679		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
680	=item $term->destroy	904	=item $term->destroy
681		905
682	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.
683		909
684	=item $isset = $term->option ($optval[, $set])	910	=item $isset = $term->option ($optval[, $set])
685		911
686	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
687	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
…		…
737	my ($self, $name) = (shift, shift);	963	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	964	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	965	&urxvt::term::_resource
740	}	966	}
741		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
742	=item $rend = $term->rstyle ([$new_rstyle])	984	=item $rend = $term->rstyle ([$new_rstyle])
743		985
744	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
745	the terminal application will use this style.	987	the terminal application will use this style.
746		988
…		…
756	=item ($row, $col) = $term->selection_end ([$row, $col])	998	=item ($row, $col) = $term->selection_end ([$row, $col])
757		999
758	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,
759	and optionally set them to new values.	1001	and optionally set them to new values.
760		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
761	=item $success = $term->selection_grab ($eventtime)	1010	=item $success = $term->selection_grab ($eventtime)
762		1011
763	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
764	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.
765		1015
766	=item $oldtext = $term->selection ([$newtext])	1016	=item $oldtext = $term->selection ([$newtext])
767		1017
768	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>.
769		1019
770	#=item $term->overlay ($x, $y, $text)	1020	=item $term->overlay_simple ($x, $y, $text)
771	#	1021
772	#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.
773	#	1023
774	#=cut	1024	=cut
775	#	1025
776	#sub urxvt::term::scr_overlay {	1026	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	1027	my ($self, $x, $y, $text) = @_;
778	#	1028
779	# my @lines = split /\n/, $text;	1029	my @lines = split /\n/, $text;
780	#	1030
781	# my $w = 0;	1031	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	1032
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1033	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1034	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	1035
		1036	$overlay
		1037	}
789		1038
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1039	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		1040
792	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
793	width/height. C<$rstyle> defines the initial rendition style	1042	width/height. C<$rstyle> defines the initial rendition style
…		…
860		1109
861	=item $string = $term->locale_decode ($octets)	1110	=item $string = $term->locale_decode ($octets)
862		1111
863	Convert the given locale-encoded octets into a perl string.	1112	Convert the given locale-encoded octets into a perl string.
864		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
865	=item $term->scr_add_lines ($string)	1131	=item $term->scr_add_lines ($string)
866		1132
867	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
868	running inside the terminal. It may not contain command sequences (escape	1134	running inside the terminal. It may not contain command sequences (escape
869	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
…		…
883		1149
884	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
885	pass characters instead of octets, you should convert your strings first	1151	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	1152	to the locale-specific encoding using C<< $term->locale_encode >>.
887		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
888	=item $windowid = $term->parent	1161	=item $windowid = $term->parent
889		1162
890	Return the window id of the toplevel window.	1163	Return the window id of the toplevel window.
891		1164
892	=item $windowid = $term->vt	1165	=item $windowid = $term->vt
893		1166
894	Return the window id of the terminal window.	1167	Return the window id of the terminal window.
895		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
896	=item $window_width = $term->width	1176	=item $window_width = $term->width
897		1177
898	=item $window_height = $term->height	1178	=item $window_height = $term->height
899		1179
900	=item $font_width = $term->fwidth	1180	=item $font_width = $term->fwidth
…		…
913		1193
914	=item $max_scrollback = $term->saveLines	1194	=item $max_scrollback = $term->saveLines
915		1195
916	=item $nrow_plus_saveLines = $term->total_rows	1196	=item $nrow_plus_saveLines = $term->total_rows
917		1197
918	=item $lines_in_scrollback = $term->nsaved	1198	=item $topmost_scrollback_row = $term->top_row
919		1199
920	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	}
921		1224
922	=item $modifiermask = $term->ModLevel3Mask	1225	=item $modifiermask = $term->ModLevel3Mask
923		1226
924	=item $modifiermask = $term->ModMetaMask	1227	=item $modifiermask = $term->ModMetaMask
925		1228
…		…
928	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
929	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.
930		1233
931	=item $view_start = $term->view_start ([$newvalue])	1234	=item $view_start = $term->view_start ([$newvalue])
932		1235
933	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
934	C<0>, which displays the normal terminal contents. Larger values scroll	1237	C<0>, which displays the normal terminal contents. Lower values scroll
935	this many lines into the scrollback buffer.	1238	this many lines into the scrollback buffer.
936		1239
937	=item $term->want_refresh	1240	=item $term->want_refresh
938		1241
939	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1242	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1018	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.
1019		1322
1020	=item $offset = $line->offset_of ($row, $col)	1323	=item $offset = $line->offset_of ($row, $col)
1021		1324
1022	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
1023	line.	1326	line. Works for rows outside the line, too, and returns corresponding
		1327	offsets outside the string.
1024		1328
1025	=item ($row, $col) = $line->coord_of ($offset)	1329	=item ($row, $col) = $line->coord_of ($offset)
1026		1330
1027	Translates a string offset into terminal coordinates again.	1331	Translates a string offset into terminal coordinates again.
1028		1332
…		…
1115	Converts rxvt-unicodes text reprsentation into a perl string. See	1419	Converts rxvt-unicodes text reprsentation into a perl string. See
1116	C<< $term->ROW_t >> for details.	1420	C<< $term->ROW_t >> for details.
1117		1421
1118	=item $success = $term->grab_button ($button, $modifiermask)	1422	=item $success = $term->grab_button ($button, $modifiermask)
1119		1423
1120	Registers a synchronous button grab. See XGrabButton.	1424	Registers a synchronous button grab. See the XGrabButton manpage.
1121		1425
1122	=item $success = $term->grab ($eventtime[, $sync])	1426	=item $success = $term->grab ($eventtime[, $sync])
1123		1427
1124	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1428	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1125	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1429	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1165	$item->{render} \|\|= sub { $_[0]{text} };	1469	$item->{render} \|\|= sub { $_[0]{text} };
1166		1470
1167	push @{ $self->{item} }, $item;	1471	push @{ $self->{item} }, $item;
1168	}	1472	}
1169		1473
1170	sub add_separator {	1474	=item $popup->add_title ($title)
1171	my ($self, $sep) = @_;
1172		1475
1173	$sep \|\|= "═";	1476	Adds a non-clickable title to the popup.
1174		1477
1175	$self->add_item ({	1478	=cut
1176	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177	text => "",
1178	render => sub { $sep x $urxvt::TERM->ncol },
1179	activate => sub { },
1180	});
1181	}
1182		1479
1183	sub add_title {	1480	sub add_title {
1184	my ($self, $title) = @_;	1481	my ($self, $title) = @_;
1185		1482
1186	$self->add_item ({	1483	$self->add_item ({
…		…
1188	text => $title,	1485	text => $title,
1189	activate => sub { },	1486	activate => sub { },
1190	});	1487	});
1191	}	1488	}
1192		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
1193	sub add_button {	1516	sub add_button {
1194	my ($self, $text, $cb) = @_;	1517	my ($self, $text, $cb) = @_;
1195		1518
1196	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1519	$self->add_item ({ type => "button", text => $text, activate => $cb});
1197	}	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
1198		1529
1199	sub add_toggle {	1530	sub add_toggle {
1200	my ($self, $text, $cb, $value) = @_;	1531	my ($self, $text, $cb, $value) = @_;
1201		1532
1202	my $item; $item = {	1533	my $item; $item = {
1203	type => "button",	1534	type => "button",
1204	text => " $text",	1535	text => " $text",
1205	value => $value,	1536	value => $value,
1206	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1537	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1538	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1208	};	1539	};
1209		1540
1210	$self->add_item ($item);	1541	$self->add_item ($item);
1211	}	1542	}
		1543
		1544	=item $popup->show
		1545
		1546	Displays the popup (which is initially hidden).
		1547
		1548	=cut
1212		1549
1213	sub show {	1550	sub show {
1214	my ($self) = @_;	1551	my ($self) = @_;
1215		1552
1216	local $urxvt::popup::self = $self;	1553	local $urxvt::popup::self = $self;
1217		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"),
1218	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,
1219	"--transient-for" => $self->{term}->parent,	1562	"--transient-for" => $self->{term}->parent,
		1563	"-display" => $self->{term}->display_id,
1220	"-pe" => "urxvt-popup")	1564	"-pe" => "urxvt-popup")
1221	or die "unable to create popup window\n";	1565	or die "unable to create popup window\n";
1222	}	1566	}
1223		1567
1224	sub DESTROY {	1568	sub DESTROY {
1225	my ($self) = @_;	1569	my ($self) = @_;
1226		1570
1227	delete $self->{term}{_destroy}{$self};	1571	delete $self->{term}{_destroy}{$self};
1228	$self->{term}->ungrab;	1572	$self->{term}->ungrab;
1229	}	1573	}
		1574
		1575	=back
1230		1576
1231	=head2 The C<urxvt::timer> Class	1577	=head2 The C<urxvt::timer> Class
1232		1578
1233	This class implements timer watchers/events. Time is represented as a	1579	This class implements timer watchers/events. Time is represented as a
1234	fractional number of seconds since the epoch. Example:	1580	fractional number of seconds since the epoch. Example:
…		…
1287		1633
1288	$term->{socket} = ...	1634	$term->{socket} = ...
1289	$term->{iow} = urxvt::iow	1635	$term->{iow} = urxvt::iow
1290	->new	1636	->new
1291	->fd (fileno $term->{socket})	1637	->fd (fileno $term->{socket})
1292	->events (1) # wait for read data	1638	->events (urxvt::EVENT_READ)
1293	->start	1639	->start
1294	->cb (sub {	1640	->cb (sub {
1295	my ($iow, $revents) = @_;	1641	my ($iow, $revents) = @_;
1296	# $revents must be 1 here, no need to check	1642	# $revents must be 1 here, no need to check
1297	sysread $term->{socket}, my $buf, 8192	1643	sysread $term->{socket}, my $buf, 8192
…		…
1314		1660
1315	Set the filedescriptor (not handle) to watch.	1661	Set the filedescriptor (not handle) to watch.
1316		1662
1317	=item $iow = $iow->events ($eventmask)	1663	=item $iow = $iow->events ($eventmask)
1318		1664
1319	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
1320	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>.
1321		1668
1322	=item $iow = $iow->start	1669	=item $iow = $iow->start
1323		1670
1324	Start watching for requested events on the given handle.	1671	Start watching for requested events on the given handle.
1325		1672
…		…
1340		1687
1341	=item == 0 - fatal messages	1688	=item == 0 - fatal messages
1342		1689
1343	=item >= 3 - script loading and management	1690	=item >= 3 - script loading and management
1344		1691
1345	=item >=10 - all events received	1692	=item >=10 - all called hooks
		1693
		1694	=item >=11 - hook reutrn values
1346		1695
1347	=back	1696	=back
1348		1697
1349	=head1 AUTHOR	1698	=head1 AUTHOR
1350		1699

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.62 by root, Mon Jan 9 02:06:43 2006 UTC vs. Revision 1.96 by root, Tue Jan 17 16:22:41 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.62 by root, Mon Jan 9 02:06:43 2006 UTC vs.
Revision 1.96 by root, Tue Jan 17 16:22:41 2006 UTC