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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.59 by root, Mon Jan 9 00:34:36 2006 UTC vs.
Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.59 by root, Mon Jan 9 00:34:36 2006 UTC vs. Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.59 by root, Mon Jan 9 00:34:36 2006 UTC vs.
Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC