[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.104 by root, Wed Jan 18 17:49:47 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.
		168
		169	=item automove-background
		170
		171	This is basically a one-line extension that dynamically changes the background pixmap offset
		172	to the window position, in effect creating the same effect as pseudo transparency with
		173	a custom pixmap. No scaling is supported in this mode. Exmaple:
		174
		175	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
78		176
79	=item block-graphics-to-ascii	177	=item block-graphics-to-ascii
80		178
81	A not very useful example of filtering all text output to the terminal,	179	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	180	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.	181	similar-looking ascii character.
84		182
		183	=item digital-clock
		184
		185	Displays a digital clock using the built-in overlay.
		186
85	=item example-refresh-hooks	187	=item example-refresh-hooks
86		188
87	Displays a very simple digital clock in the upper right corner of the	189	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	190	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	191	overlays or changes.
90		192
		193	=item selection-pastebin
		194
		195	This is a little rarely useful extension that Uploads the selection as
		196	textfile to a remote site (or does other things). (The implementation is
		197	not currently secure for use in a multiuser environment as it writes to
		198	F</tmp> directly.).
		199
		200	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		201	i.e.
		202
		203	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		204
		205	Pressing this combination runs a command with C<%> replaced by the name of
		206	the textfile. This command can be set via a resource:
		207
		208	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		209
		210	And the default is likely not useful to anybody but the few people around
		211	here :)
		212
		213	The name of the textfile is the hex encoded md5 sum of the selection, so
		214	the same content should lead to the same filename.
		215
		216	After a successful upload the selection will be replaced by the text given
		217	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		218	for the filename):
		219
		220	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		221
91	=back	222	=back
		223
		224	=head1 API DOCUMENTATION
92		225
93	=head2 General API Considerations	226	=head2 General API Considerations
94		227
95	All objects (such as terminals, time watchers etc.) are typical	228	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	229	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	242	=over 4
110		243
111	=item $text	244	=item $text
112		245
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	246	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.	247	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		248
116	=item $string	249	=item $string
117		250
118	A perl text string, with an emphasis on I<text>. It can store all unicode	251	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	252	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	257	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	258	locale-specific way.
126		259
127	=back	260	=back
128		261
		262	=head2 Extension Objects
		263
		264	Very perl extension is a perl class. A separate perl object is created
		265	for each terminal and each extension and passed as the first parameter to
		266	hooks. So extensions can use their C<$self> object without having to think
		267	about other extensions, with the exception of methods and members that
		268	begin with an underscore character C<_>: these are reserved for internal
		269	use.
		270
		271	Although it isn't a C<urxvt::term> object, you can call all methods of the
		272	C<urxvt::term> class on this object.
		273
		274	It has the following methods and data members:
		275
		276	=over 4
		277
		278	=item $urxvt_term = $self->{term}
		279
		280	Returns the C<urxvt::term> object associated with this instance of the
		281	extension. This member I<must not> be changed in any way.
		282
		283	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		284
		285	Dynamically enable the given hooks (named without the C<on_> prefix) for
		286	this extension, replacing any previous hook. This is useful when you want
		287	to overwrite time-critical hooks only temporarily.
		288
		289	=item $self->disable ($hook_name[, $hook_name..])
		290
		291	Dynamically disable the given hooks.
		292
		293	=back
		294
129	=head2 Hooks	295	=head2 Hooks
130		296
131	The following subroutines can be declared in extension files, and will be	297	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	298	called whenever the relevant event happens.
133		299
134	The first argument passed to them is an object private to each terminal	300	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	301	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		302
141	All of them must return a boolean value. If it is true, then the event	303	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,	304	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.	305	skipped, and the relevant action might not be carried out by the C++ code.
144		306
145	When in doubt, return a false value (preferably C<()>).	307	I<< When in doubt, return a false value (preferably C<()>). >>
146		308
147	=over 4	309	=over 4
148		310
149	=item on_init $term	311	=item on_init $term
150		312
…		…
185	=item on_sel_extend $term	347	=item on_sel_extend $term
186		348
187	Called whenever the user tries to extend the selection (e.g. with a double	349	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	350	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	351	should extend the selection itelf and return true to suppress the built-in
190	processing.	352	processing. This can happen multiple times, as long as the callback
		353	returns true, it will be called on every further click by the user and is
		354	supposed to enlarge the selection more and more, if possible.
191		355
192	See the F<selection> example extension.	356	See the F<selection> example extension.
193		357
194	=item on_view_change $term, $offset	358	=item on_view_change $term, $offset
195		359
…		…
204	than the scroll back buffer or the terminal.	368	than the scroll back buffer or the terminal.
205		369
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	370	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	371	$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.	372	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		373
214	=item on_osc_seq $term, $string	374	=item on_osc_seq $term, $string
215		375
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	376	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	377	operating system command) is processed. Cursor position and other state
…		…
230	can filter/change and output the text yourself by returning a true value	390	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	391	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	392	might be very slow, however, as your hook is called for B<all> text being
233	output.	393	output.
234		394
		395	=item on_tt_write $term, $octets
		396
		397	Called whenever some data is written to the tty/pty and can be used to
		398	suppress or filter tty input.
		399
235	=item on_line_update $term, $row	400	=item on_line_update $term, $row
236		401
237	Called whenever a line was updated or changed. Can be used to filter	402	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	403	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,	404	that are being shown will be filtered, and, due to performance reasons,
…		…
261		426
262	Called whenever the user presses a key combination that has a	427	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>	428	C<perl:string> action bound to it (see description of the B<keysym>
264	resource in the @@RXVT_NAME@@(1) manpage).	429	resource in the @@RXVT_NAME@@(1) manpage).
265		430
		431	=item on_x_event $term, $event
		432
		433	Called on every X event received on the vt window (and possibly other
		434	windows). Should only be used as a last resort. Most event structure
		435	members are not passed.
		436
266	=item on_focus_in $term	437	=item on_focus_in $term
267		438
268	Called whenever the window gets the keyboard focus, before rxvt-unicode	439	Called whenever the window gets the keyboard focus, before rxvt-unicode
269	does focus in processing.	440	does focus in processing.
270		441
271	=item on_focus_out $term	442	=item on_focus_out $term
272		443
273	Called wheneever the window loses keyboard focus, before rxvt-unicode does	444	Called wheneever the window loses keyboard focus, before rxvt-unicode does
274	focus out processing.	445	focus out processing.
275		446
		447	=item on_configure_notify $term, $event
		448
276	=item on_key_press $term, $event, $octets	449	=item on_key_press $term, $event, $keysym, $octets
277		450
278	=item on_key_release $term, $event	451	=item on_key_release $term, $event, $keysym
279		452
280	=item on_button_press $term, $event	453	=item on_button_press $term, $event
281		454
282	=item on_button_release $term, $event	455	=item on_button_release $term, $event
283		456
…		…
299		472
300	subwindow.	473	subwindow.
301		474
302	=back	475	=back
303		476
		477	=cut
		478
		479	package urxvt;
		480
		481	use utf8;
		482	use strict;
		483	use Carp ();
		484	use Scalar::Util ();
		485	use List::Util ();
		486
		487	our $VERSION = 1;
		488	our $TERM;
		489	our @HOOKNAME;
		490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		491	our %OPTION;
		492
		493	our $LIBDIR;
		494	our $RESNAME;
		495	our $RESCLASS;
		496	our $RXVTNAME;
		497
304	=head2 Variables in the C<urxvt> Package	498	=head2 Variables in the C<urxvt> Package
305		499
306	=over 4	500	=over 4
		501
		502	=item $urxvt::LIBDIR
		503
		504	The rxvt-unicode library directory, where, among other things, the perl
		505	modules and scripts are stored.
		506
		507	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		508
		509	The resource class and name rxvt-unicode uses to look up X resources.
		510
		511	=item $urxvt::RXVTNAME
		512
		513	The basename of the installed binaries, usually C<urxvt>.
307		514
308	=item $urxvt::TERM	515	=item $urxvt::TERM
309		516
310	The current terminal. This variable stores the current C<urxvt::term>	517	The current terminal. This variable stores the current C<urxvt::term>
311	object, whenever a callback/hook is executing.	518	object, whenever a callback/hook is executing.
…		…
313	=back	520	=back
314		521
315	=head2 Functions in the C<urxvt> Package	522	=head2 Functions in the C<urxvt> Package
316		523
317	=over 4	524	=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		525
327	=item urxvt::fatal $errormessage	526	=item urxvt::fatal $errormessage
328		527
329	Fatally aborts execution with the given error message. Avoid at all	528	Fatally aborts execution with the given error message. Avoid at all
330	costs! The only time this is acceptable is when the terminal process	529	costs! The only time this is acceptable is when the terminal process
…		…
337	that calls this function.	536	that calls this function.
338		537
339	Using this function has the advantage that its output ends up in the	538	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.	539	correct place, e.g. on stderr of the connecting urxvtc client.
341		540
		541	Messages have a size limit of 1023 bytes currently.
		542
342	=item $time = urxvt::NOW	543	=item $time = urxvt::NOW
343		544
344	Returns the "current time" (as per the event loop).	545	Returns the "current time" (as per the event loop).
345		546
346	=item urxvt::CurrentTime	547	=item urxvt::CurrentTime
347		548
348	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	549	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
349	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	550	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
350	Button4Mask, Button5Mask, AnyModifier	551	Button4Mask, Button5Mask, AnyModifier
		552
		553	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		554	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		555	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		556	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		557	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		558	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		559	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		560
		561	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		562	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		563	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		564	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		565	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		566	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		567	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
351		568
352	Various constants for use in X calls and event processing.	569	Various constants for use in X calls and event processing.
353		570
354	=back	571	=back
355		572
…		…
384		601
385	=item $background = urxvt::GET_BASEBG $rend	602	=item $background = urxvt::GET_BASEBG $rend
386		603
387	Return the foreground/background colour index, respectively.	604	Return the foreground/background colour index, respectively.
388		605
389	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
390		607
391	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	608	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
392		609
393	Replace the foreground/background colour in the rendition mask with the	610	Replace the foreground/background colour in the rendition mask with the
394	specified one.	611	specified one.
395		612
396	=item $value = urxvt::GET_CUSTOM ($rend)	613	=item $value = urxvt::GET_CUSTOM $rend
397		614
398	Return the "custom" value: Every rendition has 5 bits for use by	615	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	616	extensions. They can be set and changed as you like and are initially
400	zero.	617	zero.
401		618
402	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	619	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
403		620
404	Change the custom value.	621	Change the custom value.
405		622
406	=back	623	=back
407		624
408	=cut	625	=cut
409		626
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 {	627	BEGIN {
424	urxvt->bootstrap;
425
426	# overwrite perl's warn	628	# overwrite perl's warn
427	*CORE::GLOBAL::warn = sub {	629	*CORE::GLOBAL::warn = sub {
428	my $msg = join "", @_;	630	my $msg = join "", @_;
429	$msg .= "\n"	631	$msg .= "\n"
430	unless $msg =~ /\n$/;	632	unless $msg =~ /\n$/;
431	urxvt::warn ($msg);	633	urxvt::warn ($msg);
432	};	634	};
433		635
		636	# %ENV is the original startup environment
		637	delete $ENV{IFS};
		638	delete $ENV{CDPATH};
		639	delete $ENV{BASH_ENV};
434	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	640	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
435	delete $ENV{CDPATH};
436	}	641	}
437		642
438	my @hook_count;
439	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	643	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
440		644
441	sub verbose {	645	sub verbose {
442	my ($level, $msg) = @_;	646	my ($level, $msg) = @_;
443	warn "$msg\n" if $level <= $verbosity;	647	warn "$msg\n" if $level <= $verbosity;
444	}	648	}
445		649
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;	650	my %extension_pkg;
465		651
466	# load a single script into its own package, once only	652	# load a single script into its own package, once only
467	sub extension_package($) {	653	sub extension_package($) {
468	my ($path) = @_;	654	my ($path) = @_;
469		655
		656	no strict 'refs';
		657
470	$extension_pkg{$path} \|\|= do {	658	$extension_pkg{$path} \|\|= do {
471	my $pkg = "urxvt::" . ($extension_pkg++);	659	$path =~ /([^\/\\]+)$/;
		660	my $pkg = $1;
		661	$pkg =~ s/[^[:word:]]/_/g;
		662	$pkg = "urxvt::ext::$pkg";
472		663
473	verbose 3, "loading extension '$path' into package '$pkg'";	664	verbose 3, "loading extension '$path' into package '$pkg'";
474		665
475	open my $fh, "<:raw", $path	666	open my $fh, "<:raw", $path
476	or die "$path: $!";	667	or die "$path: $!";
477		668
		669	@{"$pkg\::ISA"} = urxvt::term::extension::;
		670
		671	my $source =
478	my $source = untaint "package $pkg; use strict; use utf8;\n"	672	"package $pkg; use strict; use utf8;\n"
479	. "use base urxvt::term::proxy::;\n"
480	. "#line 1 \"$path\"\n{\n"	673	. "#line 1 \"$path\"\n{\n"
481	. (do { local $/; <$fh> })	674	. (do { local $/; <$fh> })
482	. "\n};\n1";	675	. "\n};\n1";
483		676
		677	eval $source
484	eval $source or die "$path: $@";	678	or die "$path: $@";
485		679
486	$pkg	680	$pkg
487	}	681	}
488	}	682	}
489		683
…		…
495	my $htype = shift;	689	my $htype = shift;
496		690
497	if ($htype == 0) { # INIT	691	if ($htype == 0) { # INIT
498	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	692	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499		693
500	my %want_ext;	694	my %ext_arg;
501		695
502	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	696	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
503	if ($_ eq "default") {	697	if ($_ eq "default") {
504	$want_ext{$_}++ for qw(selection option-popup selection-popup);	698	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
505	} elsif (/^-(.*)$/) {	699	} elsif (/^-(.*)$/) {
506	delete $want_ext{$1};	700	delete $ext_arg{$1};
		701	} elsif (/^([^<]+)<(.*)>$/) {
		702	push @{ $ext_arg{$1} }, $2;
507	} else {	703	} else {
508	$want_ext{$_}++;	704	$ext_arg{$_} \|\|= [];
509	}	705	}
510	}	706	}
511		707
512	for my $ext (keys %want_ext) {	708	while (my ($ext, $argv) = each %ext_arg) {
513	my @files = grep -f $_, map "$_/$ext", @dirs;	709	my @files = grep -f $_, map "$_/$ext", @dirs;
514		710
515	if (@files) {	711	if (@files) {
516	register_package extension_package $files[0];	712	$TERM->register_package (extension_package $files[0], $argv);
517	} else {	713	} else {
518	warn "perl extension '$ext' not found in perl library search path\n";	714	warn "perl extension '$ext' not found in perl library search path\n";
519	}	715	}
520	}	716	}
521		717
…		…
530	if $verbosity >= 10;	726	if $verbosity >= 10;
531		727
532	keys %$cb;	728	keys %$cb;
533		729
534	while (my ($pkg, $cb) = each %$cb) {	730	while (my ($pkg, $cb) = each %$cb) {
535	eval {	731	$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;	732	and last;
544	};	733
545	if ($@) {	734	if ($@) {
546	$TERM->ungrab; # better to lose the grab than the session	735	$TERM->ungrab; # better to lose the grab than the session
547	warn $@;	736	warn $@;
548	}	737	}
549	}	738	}
		739
		740	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		741	if $verbosity >= 11;
550	}	742	}
551		743
552	if ($htype == 1) { # DESTROY	744	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	745	# clear package objects
562	%$_ = () for values %{ $TERM->{_pkg} };	746	%$_ = () for values %{ $TERM->{_pkg} };
563		747
564	# clear package	748	# clear package
565	%$TERM = ();	749	%$TERM = ();
566	}	750	}
567		751
568	$retval	752	$retval
569	}	753	}
570		754
571	# urxvt::term::proxy	755	sub exec_async(@) {
		756	my $pid = fork;
572		757
573	sub urxvt::term::proxy::AUTOLOAD {	758	return
574	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	759	if !defined $pid or $pid;
		760
		761	%ENV = %{ $TERM->env };
		762
		763	exec @_;
		764	_exit 255;
		765	}
		766
		767	# urxvt::term::extension
		768
		769	package urxvt::term::extension;
		770
		771	sub enable {
		772	my ($self, %hook) = @_;
		773	my $pkg = $self->{_pkg};
		774
		775	while (my ($name, $cb) = each %hook) {
		776	my $htype = $HOOKTYPE{uc $name};
		777	defined $htype
		778	or Carp::croak "unsupported hook type '$name'";
		779
		780	$self->set_should_invoke ($htype, +1)
		781	unless exists $self->{term}{_hook}[$htype]{$pkg};
		782
		783	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		784	}
		785	}
		786
		787	sub disable {
		788	my ($self, @hook) = @_;
		789	my $pkg = $self->{_pkg};
		790
		791	for my $name (@hook) {
		792	my $htype = $HOOKTYPE{uc $name};
		793	defined $htype
		794	or Carp::croak "unsupported hook type '$name'";
		795
		796	$self->set_should_invoke ($htype, -1)
		797	if delete $self->{term}{_hook}[$htype]{$pkg};
		798	}
		799	}
		800
		801	our $AUTOLOAD;
		802
		803	sub AUTOLOAD {
		804	$AUTOLOAD =~ /:([^:]+)$/
575	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	805	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
576		806
577	eval qq{	807	eval qq{
578	sub $urxvt::term::proxy::AUTOLOAD {	808	sub $AUTOLOAD {
579	my \$proxy = shift;	809	my \$proxy = shift;
580	\$proxy->{term}->$1 (\@_)	810	\$proxy->{term}->$1 (\@_)
581	}	811	}
582	1	812	1
583	} or die "FATAL: unable to compile method forwarder: $@";	813	} or die "FATAL: unable to compile method forwarder: $@";
584		814
585	goto &$urxvt::term::proxy::AUTOLOAD;	815	goto &$AUTOLOAD;
586	}	816	}
587		817
588	sub urxvt::term::proxy::DESTROY {	818	sub DESTROY {
589	# nop	819	# nop
590	}	820	}
591		821
592	# urxvt::destroy_hook	822	# urxvt::destroy_hook
593		823
…		…
603		833
604	=head2 The C<urxvt::anyevent> Class	834	=head2 The C<urxvt::anyevent> Class
605		835
606	The sole purpose of this class is to deliver an interface to the	836	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	837	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	838	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	839	condition variables, but non-blocking condvar use is ok. What this means
610	cannot use blocking APIs, but the non-blocking variant should work.	840	is that you cannot use blocking APIs, but the non-blocking variant should
		841	work.
611		842
612	=cut	843	=cut
613		844
614	our $VERSION = 1;	845	our $VERSION = 1;
615		846
…		…
660	${$_[0]}++;	891	${$_[0]}++;
661	}	892	}
662		893
663	sub urxvt::anyevent::condvar::wait {	894	sub urxvt::anyevent::condvar::wait {
664	unless (${$_[0]}) {	895	unless (${$_[0]}) {
665	require Carp;
666	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	896	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
667	}	897	}
668	}	898	}
669		899
670	package urxvt::term;	900	package urxvt::term;
671		901
672	=head2 The C<urxvt::term> Class	902	=head2 The C<urxvt::term> Class
673		903
674	=over 4	904	=over 4
675		905
		906	=cut
		907
		908	# find on_xxx subs in the package and register them
		909	# as hooks
		910	sub register_package {
		911	my ($self, $pkg, $argv) = @_;
		912
		913	my $proxy = bless {
		914	_pkg => $pkg,
		915	argv => $argv,
		916	}, $pkg;
		917	Scalar::Util::weaken ($proxy->{term} = $self);
		918
		919	$self->{_pkg}{$pkg} = $proxy;
		920
		921	for my $name (@HOOKNAME) {
		922	if (my $ref = $pkg->can ("on_" . lc $name)) {
		923	$proxy->enable ($name => $ref);
		924	}
		925	}
		926	}
		927
		928	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		929
		930	Creates a new terminal, very similar as if you had started it with system
		931	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		932	hash which defines the environment of the new terminal.
		933
		934	Croaks (and probably outputs an error message) if the new instance
		935	couldn't be created. Returns C<undef> if the new instance didn't
		936	initialise perl, and the terminal object otherwise. The C<init> and
		937	C<start> hooks will be called during this call.
		938
		939	=cut
		940
		941	sub new {
		942	my ($class, $env, @args) = @_;
		943
		944	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		945	}
		946
676	=item $term->destroy	947	=item $term->destroy
677		948
678	Destroy the terminal object (close the window, free resources etc.).	949	Destroy the terminal object (close the window, free resources
		950	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		951	watchers (timers, io watchers) are still active.
679		952
680	=item $isset = $term->option ($optval[, $set])	953	=item $isset = $term->option ($optval[, $set])
681		954
682	Returns true if the option specified by C<$optval> is enabled, and	955	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	956	optionally change it. All option values are stored by name in the hash
…		…
733	my ($self, $name) = (shift, shift);	1006	my ($self, $name) = (shift, shift);
734	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1007	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
735	&urxvt::term::_resource	1008	&urxvt::term::_resource
736	}	1009	}
737		1010
		1011	=item $value = $term->x_resource ($pattern)
		1012
		1013	Returns the X-Resource for the given pattern, excluding the program or
		1014	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1015	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1016	resource with that pattern exists.
		1017
		1018	This method should only be called during the C<on_start> hook, as there is
		1019	only one resource database per display, and later invocations might return
		1020	the wrong resources.
		1021
		1022	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1023
		1024	Adds a keymap translation exactly as specified via a resource. See the
		1025	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1026
738	=item $rend = $term->rstyle ([$new_rstyle])	1027	=item $rend = $term->rstyle ([$new_rstyle])
739		1028
740	Return and optionally change the current rendition. Text that is output by	1029	Return and optionally change the current rendition. Text that is output by
741	the terminal application will use this style.	1030	the terminal application will use this style.
742		1031
…		…
752	=item ($row, $col) = $term->selection_end ([$row, $col])	1041	=item ($row, $col) = $term->selection_end ([$row, $col])
753		1042
754	Return the current values of the selection mark, begin or end positions,	1043	Return the current values of the selection mark, begin or end positions,
755	and optionally set them to new values.	1044	and optionally set them to new values.
756		1045
		1046	=item $term->selection_make ($eventtime[, $rectangular])
		1047
		1048	Tries to make a selection as set by C<selection_beg> and
		1049	C<selection_end>. If C<$rectangular> is true (default: false), a
		1050	rectangular selection will be made. This is the prefered function to make
		1051	a selection.
		1052
757	=item $success = $term->selection_grab ($eventtime)	1053	=item $success = $term->selection_grab ($eventtime)
758		1054
759	Try to request the primary selection from the server (for example, as set	1055	Try to request the primary selection text from the server (for example, as
760	by the next method).	1056	set by the next method). No visual feedback will be given. This function
		1057	is mostly useful from within C<on_sel_grab> hooks.
761		1058
762	=item $oldtext = $term->selection ([$newtext])	1059	=item $oldtext = $term->selection ([$newtext])
763		1060
764	Return the current selection text and optionally replace it by C<$newtext>.	1061	Return the current selection text and optionally replace it by C<$newtext>.
765		1062
766	#=item $term->overlay ($x, $y, $text)	1063	=item $term->overlay_simple ($x, $y, $text)
767	#	1064
768	#Create a simple multi-line overlay box. See the next method for details.	1065	Create a simple multi-line overlay box. See the next method for details.
769	#	1066
770	#=cut	1067	=cut
771	#	1068
772	#sub urxvt::term::scr_overlay {	1069	sub overlay_simple {
773	# my ($self, $x, $y, $text) = @_;	1070	my ($self, $x, $y, $text) = @_;
774	#	1071
775	# my @lines = split /\n/, $text;	1072	my @lines = split /\n/, $text;
776	#	1073
777	# my $w = 0;	1074	my $w = List::Util::max map $self->strwidth ($_), @lines;
778	# for (map $self->strwidth ($_), @lines) {	1075
779	# $w = $_ if $w < $_;
780	# }
781	#
782	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1076	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
783	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1077	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
784	#}	1078
		1079	$overlay
		1080	}
785		1081
786	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1082	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
787		1083
788	Create a new (empty) overlay at the given position with the given	1084	Create a new (empty) overlay at the given position with the given
789	width/height. C<$rstyle> defines the initial rendition style	1085	width/height. C<$rstyle> defines the initial rendition style
…		…
856		1152
857	=item $string = $term->locale_decode ($octets)	1153	=item $string = $term->locale_decode ($octets)
858		1154
859	Convert the given locale-encoded octets into a perl string.	1155	Convert the given locale-encoded octets into a perl string.
860		1156
		1157	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1158
		1159	XORs the rendition values in the given span with the provided value
		1160	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1161	refresh hooks to provide effects similar to the selection.
		1162
		1163	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1164
		1165	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1166	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1167	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1168	it instead. Both styles I<MUST NOT> contain font styles.
		1169
		1170	=item $term->scr_bell
		1171
		1172	Ring the bell!
		1173
861	=item $term->scr_add_lines ($string)	1174	=item $term->scr_add_lines ($string)
862		1175
863	Write the given text string to the screen, as if output by the application	1176	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	1177	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	1178	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
879		1192
880	Write the octets given in C<$data> to the tty (i.e. as program input). To	1193	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	1194	pass characters instead of octets, you should convert your strings first
882	to the locale-specific encoding using C<< $term->locale_encode >>.	1195	to the locale-specific encoding using C<< $term->locale_encode >>.
883		1196
		1197	=item $old_events = $term->pty_ev_events ([$new_events])
		1198
		1199	Replaces the event mask of the pty watcher by the given event mask. Can
		1200	be used to suppress input and output handling to the pty/tty. See the
		1201	description of C<< urxvt::timer->events >>. Make sure to always restore
		1202	the previous value.
		1203
884	=item $windowid = $term->parent	1204	=item $windowid = $term->parent
885		1205
886	Return the window id of the toplevel window.	1206	Return the window id of the toplevel window.
887		1207
888	=item $windowid = $term->vt	1208	=item $windowid = $term->vt
889		1209
890	Return the window id of the terminal window.	1210	Return the window id of the terminal window.
891		1211
		1212	=item $term->vt_emask_add ($x_event_mask)
		1213
		1214	Adds the specified events to the vt event mask. Useful e.g. when you want
		1215	to receive pointer events all the times:
		1216
		1217	$term->vt_emask_add (urxvt::PointerMotionMask);
		1218
892	=item $window_width = $term->width	1219	=item $window_width = $term->width
893		1220
894	=item $window_height = $term->height	1221	=item $window_height = $term->height
895		1222
896	=item $font_width = $term->fwidth	1223	=item $font_width = $term->fwidth
…		…
909		1236
910	=item $max_scrollback = $term->saveLines	1237	=item $max_scrollback = $term->saveLines
911		1238
912	=item $nrow_plus_saveLines = $term->total_rows	1239	=item $nrow_plus_saveLines = $term->total_rows
913		1240
914	=item $lines_in_scrollback = $term->nsaved	1241	=item $topmost_scrollback_row = $term->top_row
915		1242
916	Return various integers describing terminal characteristics.	1243	Return various integers describing terminal characteristics.
		1244
		1245	=item $x_display = $term->display_id
		1246
		1247	Return the DISPLAY used by rxvt-unicode.
		1248
		1249	=item $lc_ctype = $term->locale
		1250
		1251	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1252
		1253	=item $env = $term->env
		1254
		1255	Returns a copy of the environment in effect for the terminal as a hashref
		1256	similar to C<\%ENV>.
		1257
		1258	=cut
		1259
		1260	sub env {
		1261	if (my $env = $_[0]->_env) {
		1262	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1263	} else {
		1264	+{ %ENV }
		1265	}
		1266	}
917		1267
918	=item $modifiermask = $term->ModLevel3Mask	1268	=item $modifiermask = $term->ModLevel3Mask
919		1269
920	=item $modifiermask = $term->ModMetaMask	1270	=item $modifiermask = $term->ModMetaMask
921		1271
…		…
924	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1274	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.	1275	AltGr), the meta key (often Alt) and the num lock key, if applicable.
926		1276
927	=item $view_start = $term->view_start ([$newvalue])	1277	=item $view_start = $term->view_start ([$newvalue])
928		1278
929	Returns the negative row number of the topmost line. Minimum value is	1279	Returns the row number of the topmost displayed line. Maximum value is
930	C<0>, which displays the normal terminal contents. Larger values scroll	1280	C<0>, which displays the normal terminal contents. Lower values scroll
931	this many lines into the scrollback buffer.	1281	this many lines into the scrollback buffer.
932		1282
933	=item $term->want_refresh	1283	=item $term->want_refresh
934		1284
935	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1285	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.	1364	Return the row number of the first/last row of the line, respectively.
1015		1365
1016	=item $offset = $line->offset_of ($row, $col)	1366	=item $offset = $line->offset_of ($row, $col)
1017		1367
1018	Returns the character offset of the given row\|col pair within the logical	1368	Returns the character offset of the given row\|col pair within the logical
1019	line.	1369	line. Works for rows outside the line, too, and returns corresponding
		1370	offsets outside the string.
1020		1371
1021	=item ($row, $col) = $line->coord_of ($offset)	1372	=item ($row, $col) = $line->coord_of ($offset)
1022		1373
1023	Translates a string offset into terminal coordinates again.	1374	Translates a string offset into terminal coordinates again.
1024		1375
…		…
1098	$offset / $self->{ncol} + $self->{beg},	1449	$offset / $self->{ncol} + $self->{beg},
1099	$offset % $self->{ncol}	1450	$offset % $self->{ncol}
1100	)	1451	)
1101	}	1452	}
1102		1453
1103	=item ($row, $col) = $line->coord_of ($offset)
1104	=item $text = $term->special_encode $string	1454	=item $text = $term->special_encode $string
1105		1455
1106	Converts a perl string into the special encoding used by rxvt-unicode,	1456	Converts a perl string into the special encoding used by rxvt-unicode,
1107	where one character corresponds to one screen cell. See	1457	where one character corresponds to one screen cell. See
1108	C<< $term->ROW_t >> for details.	1458	C<< $term->ROW_t >> for details.
…		…
1110	=item $string = $term->special_decode $text	1460	=item $string = $term->special_decode $text
1111		1461
1112	Converts rxvt-unicodes text reprsentation into a perl string. See	1462	Converts rxvt-unicodes text reprsentation into a perl string. See
1113	C<< $term->ROW_t >> for details.	1463	C<< $term->ROW_t >> for details.
1114		1464
		1465	=item $success = $term->grab_button ($button, $modifiermask)
		1466
		1467	Registers a synchronous button grab. See the XGrabButton manpage.
		1468
		1469	=item $success = $term->grab ($eventtime[, $sync])
		1470
		1471	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1472	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1473
		1474	=item $term->allow_events_async
		1475
		1476	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1477
		1478	=item $term->allow_events_sync
		1479
		1480	Calls XAllowEvents with SyncBoth for the most recent grab.
		1481
		1482	=item $term->allow_events_replay
		1483
		1484	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1485	recent grab.
		1486
		1487	=item $term->ungrab
		1488
		1489	Calls XUngrab for the most recent grab. Is called automatically on
		1490	evaluation errors, as it is better to lose the grab in the error case as
		1491	the session.
		1492
1115	=back	1493	=back
1116		1494
1117	=cut	1495	=cut
1118		1496
1119	package urxvt::popup;	1497	package urxvt::popup;
…		…
1134	$item->{render} \|\|= sub { $_[0]{text} };	1512	$item->{render} \|\|= sub { $_[0]{text} };
1135		1513
1136	push @{ $self->{item} }, $item;	1514	push @{ $self->{item} }, $item;
1137	}	1515	}
1138		1516
1139	sub add_separator {	1517	=item $popup->add_title ($title)
1140	my ($self, $sep) = @_;
1141		1518
1142	$sep \|\|= "═";	1519	Adds a non-clickable title to the popup.
1143		1520
1144	$self->add_item ({	1521	=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		1522
1152	sub add_title {	1523	sub add_title {
1153	my ($self, $title) = @_;	1524	my ($self, $title) = @_;
1154		1525
1155	$self->add_item ({	1526	$self->add_item ({
…		…
1157	text => $title,	1528	text => $title,
1158	activate => sub { },	1529	activate => sub { },
1159	});	1530	});
1160	}	1531	}
1161		1532
		1533	=item $popup->add_separator ([$sepchr])
		1534
		1535	Creates a separator, optionally using the character given as C<$sepchr>.
		1536
		1537	=cut
		1538
		1539	sub add_separator {
		1540	my ($self, $sep) = @_;
		1541
		1542	$sep \|\|= "=";
		1543
		1544	$self->add_item ({
		1545	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1546	text => "",
		1547	render => sub { $sep x $self->{term}->ncol },
		1548	activate => sub { },
		1549	});
		1550	}
		1551
		1552	=item $popup->add_button ($text, $cb)
		1553
		1554	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1555	selected.
		1556
		1557	=cut
		1558
1162	sub add_button {	1559	sub add_button {
1163	my ($self, $text, $cb) = @_;	1560	my ($self, $text, $cb) = @_;
1164		1561
1165	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1562	$self->add_item ({ type => "button", text => $text, activate => $cb});
1166	}	1563	}
		1564
		1565	=item $popup->add_toggle ($text, $cb, $initial_value)
		1566
		1567	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1568	whenever it gets toggled, with a boolean indicating its value as its first
		1569	argument.
		1570
		1571	=cut
1167		1572
1168	sub add_toggle {	1573	sub add_toggle {
1169	my ($self, $text, $cb, $value) = @_;	1574	my ($self, $text, $cb, $value) = @_;
1170		1575
1171	my $item; $item = {	1576	my $item; $item = {
1172	type => "button",	1577	type => "button",
1173	text => " $text",	1578	text => " $text",
1174	value => $value,	1579	value => $value,
1175	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1580	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1176	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1581	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1177	};	1582	};
1178		1583
1179	$self->add_item ($item);	1584	$self->add_item ($item);
1180	}	1585	}
		1586
		1587	=item $popup->show
		1588
		1589	Displays the popup (which is initially hidden).
		1590
		1591	=cut
1181		1592
1182	sub show {	1593	sub show {
1183	my ($self) = @_;	1594	my ($self) = @_;
1184		1595
1185	local $urxvt::popup::self = $self;	1596	local $urxvt::popup::self = $self;
1186		1597
		1598	my $env = $self->{term}->env;
		1599	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1600	delete $env->{LC_ALL};
		1601	$env->{LC_CTYPE} = $self->{term}->locale;
		1602
		1603	urxvt::term->new ($env, "popup",
1187	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1604	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1188	"--transient-for" => $self->{term}->parent,	1605	"--transient-for" => $self->{term}->parent,
		1606	"-display" => $self->{term}->display_id,
1189	"-pe" => "urxvt-popup")	1607	"-pe" => "urxvt-popup")
1190	or die "unable to create popup window\n";	1608	or die "unable to create popup window\n";
1191	}	1609	}
1192		1610
1193	sub DESTROY {	1611	sub DESTROY {
1194	my ($self) = @_;	1612	my ($self) = @_;
1195		1613
1196	delete $self->{term}{_destroy}{$self};	1614	delete $self->{term}{_destroy}{$self};
1197	$self->{term}->ungrab;	1615	$self->{term}->ungrab;
1198	}	1616	}
		1617
		1618	=back
1199		1619
1200	=head2 The C<urxvt::timer> Class	1620	=head2 The C<urxvt::timer> Class
1201		1621
1202	This class implements timer watchers/events. Time is represented as a	1622	This class implements timer watchers/events. Time is represented as a
1203	fractional number of seconds since the epoch. Example:	1623	fractional number of seconds since the epoch. Example:
…		…
1242		1662
1243	=item $timer = $timer->start ($tstamp)	1663	=item $timer = $timer->start ($tstamp)
1244		1664
1245	Set the event trigger time to C<$tstamp> and start the timer.	1665	Set the event trigger time to C<$tstamp> and start the timer.
1246		1666
		1667	=item $timer = $timer->after ($delay)
		1668
		1669	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1670
1247	=item $timer = $timer->stop	1671	=item $timer = $timer->stop
1248		1672
1249	Stop the timer.	1673	Stop the timer.
1250		1674
1251	=back	1675	=back
…		…
1256		1680
1257	$term->{socket} = ...	1681	$term->{socket} = ...
1258	$term->{iow} = urxvt::iow	1682	$term->{iow} = urxvt::iow
1259	->new	1683	->new
1260	->fd (fileno $term->{socket})	1684	->fd (fileno $term->{socket})
1261	->events (1) # wait for read data	1685	->events (urxvt::EVENT_READ)
1262	->start	1686	->start
1263	->cb (sub {	1687	->cb (sub {
1264	my ($iow, $revents) = @_;	1688	my ($iow, $revents) = @_;
1265	# $revents must be 1 here, no need to check	1689	# $revents must be 1 here, no need to check
1266	sysread $term->{socket}, my $buf, 8192	1690	sysread $term->{socket}, my $buf, 8192
…		…
1283		1707
1284	Set the filedescriptor (not handle) to watch.	1708	Set the filedescriptor (not handle) to watch.
1285		1709
1286	=item $iow = $iow->events ($eventmask)	1710	=item $iow = $iow->events ($eventmask)
1287		1711
1288	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1712	Set the event mask to watch. The only allowed values are
1289	data, Bit #1 (value C<2>) enables watching for write data.	1713	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1714	together, or C<urxvt::EVENT_NONE>.
1290		1715
1291	=item $iow = $iow->start	1716	=item $iow = $iow->start
1292		1717
1293	Start watching for requested events on the given handle.	1718	Start watching for requested events on the given handle.
1294		1719
…		…
1309		1734
1310	=item == 0 - fatal messages	1735	=item == 0 - fatal messages
1311		1736
1312	=item >= 3 - script loading and management	1737	=item >= 3 - script loading and management
1313		1738
1314	=item >=10 - all events received	1739	=item >=10 - all called hooks
		1740
		1741	=item >=11 - hook reutrn values
1315		1742
1316	=back	1743	=back
1317		1744
1318	=head1 AUTHOR	1745	=head1 AUTHOR
1319		1746

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.104 by root, Wed Jan 18 17:49:47 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.104 by root, Wed Jan 18 17:49:47 2006 UTC