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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.53 by root, Sun Jan 8 01:16:09 2006 UTC vs. Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.53 by root, Sun Jan 8 01:16:09 2006 UTC vs.
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC