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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC vs.
Revision 1.95 by elmex, Tue Jan 17 13:19:45 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
…		…
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
		503	=item $is_safe = urxvt::safe
		504
		505	Returns true when it is safe to do potentially unsafe things, such as
		506	evaluating perl code specified by the user. This is true when urxvt was
		507	started setuid or setgid.
		508
342	=item $time = urxvt::NOW	509	=item $time = urxvt::NOW
343		510
344	Returns the "current time" (as per the event loop).	511	Returns the "current time" (as per the event loop).
345		512
346	=item urxvt::CurrentTime	513	=item urxvt::CurrentTime
347		514
348	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	515	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
349	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	516	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
350	Button4Mask, Button5Mask, AnyModifier	517	Button4Mask, Button5Mask, AnyModifier
		518
		519	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		520	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		521	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		522	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		523	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		524	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		525	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		526
		527	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		528	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		529	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		530	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		531	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		532	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		533	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
351		534
352	Various constants for use in X calls and event processing.	535	Various constants for use in X calls and event processing.
353		536
354	=back	537	=back
355		538
…		…
384		567
385	=item $background = urxvt::GET_BASEBG $rend	568	=item $background = urxvt::GET_BASEBG $rend
386		569
387	Return the foreground/background colour index, respectively.	570	Return the foreground/background colour index, respectively.
388		571
389	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	572	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
390		573
391	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	574	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
392		575
393	Replace the foreground/background colour in the rendition mask with the	576	Replace the foreground/background colour in the rendition mask with the
394	specified one.	577	specified one.
395		578
396	=item $value = urxvt::GET_CUSTOM ($rend)	579	=item $value = urxvt::GET_CUSTOM $rend
397		580
398	Return the "custom" value: Every rendition has 5 bits for use by	581	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	582	extensions. They can be set and changed as you like and are initially
400	zero.	583	zero.
401		584
402	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	585	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
403		586
404	Change the custom value.	587	Change the custom value.
405		588
406	=back	589	=back
407		590
408	=cut	591	=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		592
423	BEGIN {	593	BEGIN {
424	urxvt->bootstrap;	594	urxvt->bootstrap;
425		595
426	# overwrite perl's warn	596	# overwrite perl's warn
…		…
429	$msg .= "\n"	599	$msg .= "\n"
430	unless $msg =~ /\n$/;	600	unless $msg =~ /\n$/;
431	urxvt::warn ($msg);	601	urxvt::warn ($msg);
432	};	602	};
433		603
		604	# %ENV is the original startup environment
434	delete $ENV{IFS};	605	delete $ENV{IFS};
435	delete $ENV{CDPATH};	606	delete $ENV{CDPATH};
436	delete $ENV{BASH_ENV};	607	delete $ENV{BASH_ENV};
437	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	608	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
438	}	609	}
439		610
440	my @hook_count;
441	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	611	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
442		612
443	sub verbose {	613	sub verbose {
444	my ($level, $msg) = @_;	614	my ($level, $msg) = @_;
445	warn "$msg\n" if $level <= $verbosity;	615	warn "$msg\n" if $level <= $verbosity;
446	}	616	}
447		617
448	# find on_xxx subs in the package and register them
449	# as hooks
450	sub register_package($) {
451	my ($pkg) = @_;
452
453	for my $htype (0.. $#HOOKNAME) {
454	my $name = $HOOKNAME[$htype];
455
456	my $ref = $pkg->can ("on_" . lc $name)
457	or next;
458
459	$TERM->{_hook}[$htype]{$pkg} = $ref;
460	$hook_count[$htype]++
461	or set_should_invoke $htype, 1;
462	}
463	}
464
465	my $extension_pkg = "extension0000";	618	my $extension_pkg = "extension0000";
466	my %extension_pkg;	619	my %extension_pkg;
467		620
468	# load a single script into its own package, once only	621	# load a single script into its own package, once only
469	sub extension_package($) {	622	sub extension_package($) {
…		…
475	verbose 3, "loading extension '$path' into package '$pkg'";	628	verbose 3, "loading extension '$path' into package '$pkg'";
476		629
477	open my $fh, "<:raw", $path	630	open my $fh, "<:raw", $path
478	or die "$path: $!";	631	or die "$path: $!";
479		632
		633	my $source = untaint
480	my $source = untaint "package $pkg; use strict; use utf8;\n"	634	"package $pkg; use strict; use utf8;\n"
481	. "use base urxvt::term::proxy::;\n"	635	. "use base urxvt::term::extension::;\n"
482	. "#line 1 \"$path\"\n{\n"	636	. "#line 1 \"$path\"\n{\n"
483	. (do { local $/; <$fh> })	637	. (do { local $/; <$fh> })
484	. "\n};\n1";	638	. "\n};\n1";
485		639
		640	eval $source
486	eval $source or die "$path: $@";	641	or die "$path: $@";
487		642
488	$pkg	643	$pkg
489	}	644	}
490	}	645	}
491		646
…		…
497	my $htype = shift;	652	my $htype = shift;
498		653
499	if ($htype == 0) { # INIT	654	if ($htype == 0) { # INIT
500	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	655	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
501		656
502	my %want_ext;	657	my %ext_arg;
503		658
504	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	659	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
505	if ($_ eq "default") {	660	if ($_ eq "default") {
506	$want_ext{$_}++ for qw(selection option-popup selection-popup);	661	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
507	} elsif (/^-(.*)$/) {	662	} elsif (/^-(.*)$/) {
508	delete $want_ext{$1};	663	delete $ext_arg{$1};
		664	} elsif (/^([^<]+)<(.*)>$/) {
		665	push @{ $ext_arg{$1} }, $2;
509	} else {	666	} else {
510	$want_ext{$_}++;	667	$ext_arg{$_} \|\|= [];
511	}	668	}
512	}	669	}
513		670
514	for my $ext (keys %want_ext) {	671	while (my ($ext, $argv) = each %ext_arg) {
515	my @files = grep -f $_, map "$_/$ext", @dirs;	672	my @files = grep -f $_, map "$_/$ext", @dirs;
516		673
517	if (@files) {	674	if (@files) {
518	register_package extension_package $files[0];	675	$TERM->register_package (extension_package $files[0], $argv);
519	} else {	676	} else {
520	warn "perl extension '$ext' not found in perl library search path\n";	677	warn "perl extension '$ext' not found in perl library search path\n";
521	}	678	}
522	}	679	}
523		680
…		…
532	if $verbosity >= 10;	689	if $verbosity >= 10;
533		690
534	keys %$cb;	691	keys %$cb;
535		692
536	while (my ($pkg, $cb) = each %$cb) {	693	while (my ($pkg, $cb) = each %$cb) {
537	eval {	694	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
538	$retval = $cb->(
539	$TERM->{_pkg}{$pkg} \|\|= do {
540	my $proxy = bless { }, $pkg;
541	Scalar::Util::weaken ($proxy->{term} = $TERM);
542	$proxy
543	},
544	@_,
545	) and last;	695	and last;
546	};	696
547	if ($@) {	697	if ($@) {
548	$TERM->ungrab; # better to lose the grab than the session	698	$TERM->ungrab; # better to lose the grab than the session
549	warn $@;	699	warn $@;
550	}	700	}
551	}	701	}
		702
		703	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		704	if $verbosity >= 11;
552	}	705	}
553		706
554	if ($htype == 1) { # DESTROY	707	if ($htype == 1) { # DESTROY
555	# remove hooks if unused
556	if (my $hook = $TERM->{_hook}) {
557	for my $htype (0..$#$hook) {
558	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
559	or set_should_invoke $htype, 0;
560	}
561	}
562
563	# clear package objects	708	# clear package objects
564	%$_ = () for values %{ $TERM->{_pkg} };	709	%$_ = () for values %{ $TERM->{_pkg} };
565		710
566	# clear package	711	# clear package
567	%$TERM = ();	712	%$TERM = ();
568	}	713	}
569		714
570	$retval	715	$retval
571	}	716	}
572		717
573	# urxvt::term::proxy	718	sub exec_async(@) {
		719	my $pid = fork;
574		720
575	sub urxvt::term::proxy::AUTOLOAD {	721	return
576	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	722	if !defined $pid or $pid;
		723
		724	%ENV = %{ $TERM->env };
		725
		726	exec @_;
		727	_exit 255;
		728	}
		729
		730	# urxvt::term::extension
		731
		732	package urxvt::term::extension;
		733
		734	sub enable {
		735	my ($self, %hook) = @_;
		736	my $pkg = $self->{_pkg};
		737
		738	while (my ($name, $cb) = each %hook) {
		739	my $htype = $HOOKTYPE{uc $name};
		740	defined $htype
		741	or Carp::croak "unsupported hook type '$name'";
		742
		743	$self->set_should_invoke ($htype, +1)
		744	unless exists $self->{term}{_hook}[$htype]{$pkg};
		745
		746	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		747	}
		748	}
		749
		750	sub disable {
		751	my ($self, @hook) = @_;
		752	my $pkg = $self->{_pkg};
		753
		754	for my $name (@hook) {
		755	my $htype = $HOOKTYPE{uc $name};
		756	defined $htype
		757	or Carp::croak "unsupported hook type '$name'";
		758
		759	$self->set_should_invoke ($htype, -1)
		760	if delete $self->{term}{_hook}[$htype]{$pkg};
		761	}
		762	}
		763
		764	our $AUTOLOAD;
		765
		766	sub AUTOLOAD {
		767	$AUTOLOAD =~ /:([^:]+)$/
577	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	768	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
578		769
579	eval qq{	770	eval qq{
580	sub $urxvt::term::proxy::AUTOLOAD {	771	sub $AUTOLOAD {
581	my \$proxy = shift;	772	my \$proxy = shift;
582	\$proxy->{term}->$1 (\@_)	773	\$proxy->{term}->$1 (\@_)
583	}	774	}
584	1	775	1
585	} or die "FATAL: unable to compile method forwarder: $@";	776	} or die "FATAL: unable to compile method forwarder: $@";
586		777
587	goto &$urxvt::term::proxy::AUTOLOAD;	778	goto &$AUTOLOAD;
588	}	779	}
589		780
590	sub urxvt::term::proxy::DESTROY {	781	sub DESTROY {
591	# nop	782	# nop
592	}	783	}
593		784
594	# urxvt::destroy_hook	785	# urxvt::destroy_hook
595		786
…		…
605		796
606	=head2 The C<urxvt::anyevent> Class	797	=head2 The C<urxvt::anyevent> Class
607		798
608	The sole purpose of this class is to deliver an interface to the	799	The sole purpose of this class is to deliver an interface to the
609	C<AnyEvent> module - any module using it will work inside urxvt without	800	C<AnyEvent> module - any module using it will work inside urxvt without
610	further work. The only exception is that you cannot wait on condition	801	further programming. The only exception is that you cannot wait on
611	variables, but non-blocking condvar use is ok. What this means is that you	802	condition variables, but non-blocking condvar use is ok. What this means
612	cannot use blocking APIs, but the non-blocking variant should work.	803	is that you cannot use blocking APIs, but the non-blocking variant should
		804	work.
613		805
614	=cut	806	=cut
615		807
616	our $VERSION = 1;	808	our $VERSION = 1;
617		809
…		…
662	${$_[0]}++;	854	${$_[0]}++;
663	}	855	}
664		856
665	sub urxvt::anyevent::condvar::wait {	857	sub urxvt::anyevent::condvar::wait {
666	unless (${$_[0]}) {	858	unless (${$_[0]}) {
667	require Carp;
668	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	859	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
669	}	860	}
670	}	861	}
671		862
672	package urxvt::term;	863	package urxvt::term;
673		864
674	=head2 The C<urxvt::term> Class	865	=head2 The C<urxvt::term> Class
675		866
676	=over 4	867	=over 4
677		868
		869	=cut
		870
		871	# find on_xxx subs in the package and register them
		872	# as hooks
		873	sub register_package {
		874	my ($self, $pkg, $argv) = @_;
		875
		876	my $proxy = bless {
		877	_pkg => $pkg,
		878	argv => $argv,
		879	}, $pkg;
		880	Scalar::Util::weaken ($proxy->{term} = $self);
		881
		882	$self->{_pkg}{$pkg} = $proxy;
		883
		884	for my $name (@HOOKNAME) {
		885	if (my $ref = $pkg->can ("on_" . lc $name)) {
		886	$proxy->enable ($name => $ref);
		887	}
		888	}
		889	}
		890
		891	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		892
		893	Creates a new terminal, very similar as if you had started it with system
		894	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		895	hash which defines the environment of the new terminal.
		896
		897	Croaks (and probably outputs an error message) if the new instance
		898	couldn't be created. Returns C<undef> if the new instance didn't
		899	initialise perl, and the terminal object otherwise. The C<init> and
		900	C<start> hooks will be called during this call.
		901
		902	=cut
		903
		904	sub new {
		905	my ($class, $env, @args) = @_;
		906
		907	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		908	}
		909
678	=item $term->destroy	910	=item $term->destroy
679		911
680	Destroy the terminal object (close the window, free resources etc.).	912	Destroy the terminal object (close the window, free resources
		913	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		914	watchers (timers, io watchers) are still active.
681		915
682	=item $isset = $term->option ($optval[, $set])	916	=item $isset = $term->option ($optval[, $set])
683		917
684	Returns true if the option specified by C<$optval> is enabled, and	918	Returns true if the option specified by C<$optval> is enabled, and
685	optionally change it. All option values are stored by name in the hash	919	optionally change it. All option values are stored by name in the hash
…		…
735	my ($self, $name) = (shift, shift);	969	my ($self, $name) = (shift, shift);
736	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	970	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
737	&urxvt::term::_resource	971	&urxvt::term::_resource
738	}	972	}
739		973
		974	=item $value = $term->x_resource ($pattern)
		975
		976	Returns the X-Resource for the given pattern, excluding the program or
		977	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		978	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		979	resource with that pattern exists.
		980
		981	This method should only be called during the C<on_start> hook, as there is
		982	only one resource database per display, and later invocations might return
		983	the wrong resources.
		984
		985	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		986
		987	Adds a keymap translation exactly as specified via a resource. See the
		988	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		989
740	=item $rend = $term->rstyle ([$new_rstyle])	990	=item $rend = $term->rstyle ([$new_rstyle])
741		991
742	Return and optionally change the current rendition. Text that is output by	992	Return and optionally change the current rendition. Text that is output by
743	the terminal application will use this style.	993	the terminal application will use this style.
744		994
…		…
754	=item ($row, $col) = $term->selection_end ([$row, $col])	1004	=item ($row, $col) = $term->selection_end ([$row, $col])
755		1005
756	Return the current values of the selection mark, begin or end positions,	1006	Return the current values of the selection mark, begin or end positions,
757	and optionally set them to new values.	1007	and optionally set them to new values.
758		1008
		1009	=item $term->selection_make ($eventtime[, $rectangular])
		1010
		1011	Tries to make a selection as set by C<selection_beg> and
		1012	C<selection_end>. If C<$rectangular> is true (default: false), a
		1013	rectangular selection will be made. This is the prefered function to make
		1014	a selection.
		1015
759	=item $success = $term->selection_grab ($eventtime)	1016	=item $success = $term->selection_grab ($eventtime)
760		1017
761	Try to request the primary selection from the server (for example, as set	1018	Try to request the primary selection text from the server (for example, as
762	by the next method).	1019	set by the next method). No visual feedback will be given. This function
		1020	is mostly useful from within C<on_sel_grab> hooks.
763		1021
764	=item $oldtext = $term->selection ([$newtext])	1022	=item $oldtext = $term->selection ([$newtext])
765		1023
766	Return the current selection text and optionally replace it by C<$newtext>.	1024	Return the current selection text and optionally replace it by C<$newtext>.
767		1025
768	#=item $term->overlay ($x, $y, $text)	1026	=item $term->overlay_simple ($x, $y, $text)
769	#	1027
770	#Create a simple multi-line overlay box. See the next method for details.	1028	Create a simple multi-line overlay box. See the next method for details.
771	#	1029
772	#=cut	1030	=cut
773	#	1031
774	#sub urxvt::term::scr_overlay {	1032	sub overlay_simple {
775	# my ($self, $x, $y, $text) = @_;	1033	my ($self, $x, $y, $text) = @_;
776	#	1034
777	# my @lines = split /\n/, $text;	1035	my @lines = split /\n/, $text;
778	#	1036
779	# my $w = 0;	1037	my $w = List::Util::max map $self->strwidth ($_), @lines;
780	# for (map $self->strwidth ($_), @lines) {	1038
781	# $w = $_ if $w < $_;
782	# }
783	#
784	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1039	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
785	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1040	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
786	#}	1041
		1042	$overlay
		1043	}
787		1044
788	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1045	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
789		1046
790	Create a new (empty) overlay at the given position with the given	1047	Create a new (empty) overlay at the given position with the given
791	width/height. C<$rstyle> defines the initial rendition style	1048	width/height. C<$rstyle> defines the initial rendition style
…		…
858		1115
859	=item $string = $term->locale_decode ($octets)	1116	=item $string = $term->locale_decode ($octets)
860		1117
861	Convert the given locale-encoded octets into a perl string.	1118	Convert the given locale-encoded octets into a perl string.
862		1119
		1120	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1121
		1122	XORs the rendition values in the given span with the provided value
		1123	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1124	refresh hooks to provide effects similar to the selection.
		1125
		1126	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1127
		1128	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1129	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1130	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1131	it instead. Both styles I<MUST NOT> contain font styles.
		1132
		1133	=item $term->scr_bell
		1134
		1135	Ring the bell!
		1136
863	=item $term->scr_add_lines ($string)	1137	=item $term->scr_add_lines ($string)
864		1138
865	Write the given text string to the screen, as if output by the application	1139	Write the given text string to the screen, as if output by the application
866	running inside the terminal. It may not contain command sequences (escape	1140	running inside the terminal. It may not contain command sequences (escape
867	codes), but is free to use line feeds, carriage returns and tabs. The	1141	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
881		1155
882	Write the octets given in C<$data> to the tty (i.e. as program input). To	1156	Write the octets given in C<$data> to the tty (i.e. as program input). To
883	pass characters instead of octets, you should convert your strings first	1157	pass characters instead of octets, you should convert your strings first
884	to the locale-specific encoding using C<< $term->locale_encode >>.	1158	to the locale-specific encoding using C<< $term->locale_encode >>.
885		1159
		1160	=item $old_events = $term->pty_ev_events ([$new_events])
		1161
		1162	Replaces the event mask of the pty watcher by the given event mask. Can
		1163	be used to suppress input and output handling to the pty/tty. See the
		1164	description of C<< urxvt::timer->events >>. Make sure to always restore
		1165	the previous value.
		1166
886	=item $windowid = $term->parent	1167	=item $windowid = $term->parent
887		1168
888	Return the window id of the toplevel window.	1169	Return the window id of the toplevel window.
889		1170
890	=item $windowid = $term->vt	1171	=item $windowid = $term->vt
891		1172
892	Return the window id of the terminal window.	1173	Return the window id of the terminal window.
893		1174
		1175	=item $term->vt_emask_add ($x_event_mask)
		1176
		1177	Adds the specified events to the vt event mask. Useful e.g. when you want
		1178	to receive pointer events all the times:
		1179
		1180	$term->vt_emask_add (urxvt::PointerMotionMask);
		1181
894	=item $window_width = $term->width	1182	=item $window_width = $term->width
895		1183
896	=item $window_height = $term->height	1184	=item $window_height = $term->height
897		1185
898	=item $font_width = $term->fwidth	1186	=item $font_width = $term->fwidth
…		…
911		1199
912	=item $max_scrollback = $term->saveLines	1200	=item $max_scrollback = $term->saveLines
913		1201
914	=item $nrow_plus_saveLines = $term->total_rows	1202	=item $nrow_plus_saveLines = $term->total_rows
915		1203
916	=item $lines_in_scrollback = $term->nsaved	1204	=item $topmost_scrollback_row = $term->top_row
917		1205
918	Return various integers describing terminal characteristics.	1206	Return various integers describing terminal characteristics.
		1207
		1208	=item $x_display = $term->display_id
		1209
		1210	Return the DISPLAY used by rxvt-unicode.
		1211
		1212	=item $lc_ctype = $term->locale
		1213
		1214	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1215
		1216	=item $env = $term->env
		1217
		1218	Returns a copy of the environment in effect for the terminal as a hashref
		1219	similar to C<\%ENV>.
		1220
		1221	=cut
		1222
		1223	sub env {
		1224	if (my $env = $_[0]->_env) {
		1225	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1226	} else {
		1227	+{ %ENV }
		1228	}
		1229	}
919		1230
920	=item $modifiermask = $term->ModLevel3Mask	1231	=item $modifiermask = $term->ModLevel3Mask
921		1232
922	=item $modifiermask = $term->ModMetaMask	1233	=item $modifiermask = $term->ModMetaMask
923		1234
…		…
926	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1237	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
927	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1238	AltGr), the meta key (often Alt) and the num lock key, if applicable.
928		1239
929	=item $view_start = $term->view_start ([$newvalue])	1240	=item $view_start = $term->view_start ([$newvalue])
930		1241
931	Returns the negative row number of the topmost line. Minimum value is	1242	Returns the row number of the topmost displayed line. Maximum value is
932	C<0>, which displays the normal terminal contents. Larger values scroll	1243	C<0>, which displays the normal terminal contents. Lower values scroll
933	this many lines into the scrollback buffer.	1244	this many lines into the scrollback buffer.
934		1245
935	=item $term->want_refresh	1246	=item $term->want_refresh
936		1247
937	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1248	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1016	Return the row number of the first/last row of the line, respectively.	1327	Return the row number of the first/last row of the line, respectively.
1017		1328
1018	=item $offset = $line->offset_of ($row, $col)	1329	=item $offset = $line->offset_of ($row, $col)
1019		1330
1020	Returns the character offset of the given row\|col pair within the logical	1331	Returns the character offset of the given row\|col pair within the logical
1021	line.	1332	line. Works for rows outside the line, too, and returns corresponding
		1333	offsets outside the string.
1022		1334
1023	=item ($row, $col) = $line->coord_of ($offset)	1335	=item ($row, $col) = $line->coord_of ($offset)
1024		1336
1025	Translates a string offset into terminal coordinates again.	1337	Translates a string offset into terminal coordinates again.
1026		1338
…		…
1100	$offset / $self->{ncol} + $self->{beg},	1412	$offset / $self->{ncol} + $self->{beg},
1101	$offset % $self->{ncol}	1413	$offset % $self->{ncol}
1102	)	1414	)
1103	}	1415	}
1104		1416
1105	=item ($row, $col) = $line->coord_of ($offset)
1106	=item $text = $term->special_encode $string	1417	=item $text = $term->special_encode $string
1107		1418
1108	Converts a perl string into the special encoding used by rxvt-unicode,	1419	Converts a perl string into the special encoding used by rxvt-unicode,
1109	where one character corresponds to one screen cell. See	1420	where one character corresponds to one screen cell. See
1110	C<< $term->ROW_t >> for details.	1421	C<< $term->ROW_t >> for details.
…		…
1112	=item $string = $term->special_decode $text	1423	=item $string = $term->special_decode $text
1113		1424
1114	Converts rxvt-unicodes text reprsentation into a perl string. See	1425	Converts rxvt-unicodes text reprsentation into a perl string. See
1115	C<< $term->ROW_t >> for details.	1426	C<< $term->ROW_t >> for details.
1116		1427
		1428	=item $success = $term->grab_button ($button, $modifiermask)
		1429
		1430	Registers a synchronous button grab. See the XGrabButton manpage.
		1431
		1432	=item $success = $term->grab ($eventtime[, $sync])
		1433
		1434	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1435	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1436
		1437	=item $term->allow_events_async
		1438
		1439	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1440
		1441	=item $term->allow_events_sync
		1442
		1443	Calls XAllowEvents with SyncBoth for the most recent grab.
		1444
		1445	=item $term->allow_events_replay
		1446
		1447	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1448	recent grab.
		1449
		1450	=item $term->ungrab
		1451
		1452	Calls XUngrab for the most recent grab. Is called automatically on
		1453	evaluation errors, as it is better to lose the grab in the error case as
		1454	the session.
		1455
1117	=back	1456	=back
1118		1457
1119	=cut	1458	=cut
1120		1459
1121	package urxvt::popup;	1460	package urxvt::popup;
…		…
1136	$item->{render} \|\|= sub { $_[0]{text} };	1475	$item->{render} \|\|= sub { $_[0]{text} };
1137		1476
1138	push @{ $self->{item} }, $item;	1477	push @{ $self->{item} }, $item;
1139	}	1478	}
1140		1479
1141	sub add_separator {	1480	=item $popup->add_title ($title)
1142	my ($self, $sep) = @_;
1143		1481
1144	$sep \|\|= "═";	1482	Adds a non-clickable title to the popup.
1145		1483
1146	$self->add_item ({	1484	=cut
1147	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1148	text => "",
1149	render => sub { $sep x $urxvt::TERM->ncol },
1150	activate => sub { },
1151	});
1152	}
1153		1485
1154	sub add_title {	1486	sub add_title {
1155	my ($self, $title) = @_;	1487	my ($self, $title) = @_;
1156		1488
1157	$self->add_item ({	1489	$self->add_item ({
…		…
1159	text => $title,	1491	text => $title,
1160	activate => sub { },	1492	activate => sub { },
1161	});	1493	});
1162	}	1494	}
1163		1495
		1496	=item $popup->add_separator ([$sepchr])
		1497
		1498	Creates a separator, optionally using the character given as C<$sepchr>.
		1499
		1500	=cut
		1501
		1502	sub add_separator {
		1503	my ($self, $sep) = @_;
		1504
		1505	$sep \|\|= "=";
		1506
		1507	$self->add_item ({
		1508	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1509	text => "",
		1510	render => sub { $sep x $self->{term}->ncol },
		1511	activate => sub { },
		1512	});
		1513	}
		1514
		1515	=item $popup->add_button ($text, $cb)
		1516
		1517	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1518	selected.
		1519
		1520	=cut
		1521
1164	sub add_button {	1522	sub add_button {
1165	my ($self, $text, $cb) = @_;	1523	my ($self, $text, $cb) = @_;
1166		1524
1167	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1525	$self->add_item ({ type => "button", text => $text, activate => $cb});
1168	}	1526	}
		1527
		1528	=item $popup->add_toggle ($text, $cb, $initial_value)
		1529
		1530	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1531	whenever it gets toggled, with a boolean indicating its value as its first
		1532	argument.
		1533
		1534	=cut
1169		1535
1170	sub add_toggle {	1536	sub add_toggle {
1171	my ($self, $text, $cb, $value) = @_;	1537	my ($self, $text, $cb, $value) = @_;
1172		1538
1173	my $item; $item = {	1539	my $item; $item = {
1174	type => "button",	1540	type => "button",
1175	text => " $text",	1541	text => " $text",
1176	value => $value,	1542	value => $value,
1177	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1543	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1178	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1544	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1179	};	1545	};
1180		1546
1181	$self->add_item ($item);	1547	$self->add_item ($item);
1182	}	1548	}
		1549
		1550	=item $popup->show
		1551
		1552	Displays the popup (which is initially hidden).
		1553
		1554	=cut
1183		1555
1184	sub show {	1556	sub show {
1185	my ($self) = @_;	1557	my ($self) = @_;
1186		1558
1187	local $urxvt::popup::self = $self;	1559	local $urxvt::popup::self = $self;
1188		1560
		1561	my $env = $self->{term}->env;
		1562	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1563	delete $env->{LC_ALL};
		1564	$env->{LC_CTYPE} = $self->{term}->locale;
		1565
		1566	urxvt::term->new ($env, $self->{term}->resource ("name"),
1189	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1567	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1190	"--transient-for" => $self->{term}->parent,	1568	"--transient-for" => $self->{term}->parent,
		1569	"-display" => $self->{term}->display_id,
1191	"-pe" => "urxvt-popup")	1570	"-pe" => "urxvt-popup")
1192	or die "unable to create popup window\n";	1571	or die "unable to create popup window\n";
1193	}	1572	}
1194		1573
1195	sub DESTROY {	1574	sub DESTROY {
1196	my ($self) = @_;	1575	my ($self) = @_;
1197		1576
1198	delete $self->{term}{_destroy}{$self};	1577	delete $self->{term}{_destroy}{$self};
1199	$self->{term}->ungrab;	1578	$self->{term}->ungrab;
1200	}	1579	}
		1580
		1581	=back
1201		1582
1202	=head2 The C<urxvt::timer> Class	1583	=head2 The C<urxvt::timer> Class
1203		1584
1204	This class implements timer watchers/events. Time is represented as a	1585	This class implements timer watchers/events. Time is represented as a
1205	fractional number of seconds since the epoch. Example:	1586	fractional number of seconds since the epoch. Example:
…		…
1258		1639
1259	$term->{socket} = ...	1640	$term->{socket} = ...
1260	$term->{iow} = urxvt::iow	1641	$term->{iow} = urxvt::iow
1261	->new	1642	->new
1262	->fd (fileno $term->{socket})	1643	->fd (fileno $term->{socket})
1263	->events (1) # wait for read data	1644	->events (urxvt::EVENT_READ)
1264	->start	1645	->start
1265	->cb (sub {	1646	->cb (sub {
1266	my ($iow, $revents) = @_;	1647	my ($iow, $revents) = @_;
1267	# $revents must be 1 here, no need to check	1648	# $revents must be 1 here, no need to check
1268	sysread $term->{socket}, my $buf, 8192	1649	sysread $term->{socket}, my $buf, 8192
…		…
1285		1666
1286	Set the filedescriptor (not handle) to watch.	1667	Set the filedescriptor (not handle) to watch.
1287		1668
1288	=item $iow = $iow->events ($eventmask)	1669	=item $iow = $iow->events ($eventmask)
1289		1670
1290	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1671	Set the event mask to watch. The only allowed values are
1291	data, Bit #1 (value C<2>) enables watching for write data.	1672	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1673	together, or C<urxvt::EVENT_NONE>.
1292		1674
1293	=item $iow = $iow->start	1675	=item $iow = $iow->start
1294		1676
1295	Start watching for requested events on the given handle.	1677	Start watching for requested events on the given handle.
1296		1678
…		…
1311		1693
1312	=item == 0 - fatal messages	1694	=item == 0 - fatal messages
1313		1695
1314	=item >= 3 - script loading and management	1696	=item >= 3 - script loading and management
1315		1697
1316	=item >=10 - all events received	1698	=item >=10 - all called hooks
		1699
		1700	=item >=11 - hook reutrn values
1317		1701
1318	=back	1702	=back
1319		1703
1320	=head1 AUTHOR	1704	=head1 AUTHOR
1321		1705

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC vs. Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC vs.
Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC