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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC vs. Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC