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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.53 by root, Sun Jan 8 01:16:09 2006 UTC vs.
Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	47	arguments, which is very convenient, too, if your F<ls> supports
		48	C<--quoting-style=shell>.
48		49
49	It also offers the following bindable event:	50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
		53	The selection works by trying to match a number of regexes and displaying
		54	them in increasing order of length. You can add your own regexes by
		55	specifying resources of the form:
		56
		57	URxvt.selection.pattern-0: perl-regex
		58	URxvt.selection.pattern-1: perl-regex
		59	...
		60
		61	The index number (0, 1...) must not have any holes, and each regex must
		62	contain at least one pair of capturing parentheses, which will be used for
		63	the match. For example, the followign adds a regex that matches everything
		64	between two vertical bars:
		65
		66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		67
		68	You can look at the source of the selection extension to see more
		69	interesting uses, such as parsing a line from beginning to end.
		70
		71	This extension also offers following bindable keyboard commands:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
…		…
56		78
57	URxvt.keysym.C-M-r: perl:selection:rot13	79	URxvt.keysym.C-M-r: perl:selection:rot13
58		80
59	=back	81	=back
60		82
61	=item digital-clock	83	=item option-popup (enabled by default)
62		84
63	Displays a digital clock using the built-in overlay.	85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		86	runtime.
		87
		88	=item selection-popup (enabled by default)
		89
		90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
		93
		94	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.
		96
		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.
64		161
65	=item mark-urls	162	=item mark-urls
66		163
67	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
68		176
69	=item block-graphics-to-ascii	177	=item block-graphics-to-ascii
70		178
71	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,
72	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
73	similar-looking ascii character.	181	similar-looking ascii character.
74		182
		183	=item digital-clock
		184
		185	Displays a digital clock using the built-in overlay.
		186
75	=item example-refresh-hooks	187	=item example-refresh-hooks
76		188
77	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
78	window. Illustrates overwriting the refresh callbacks to create your own	190	window. Illustrates overwriting the refresh callbacks to create your own
79	overlays or changes.	191	overlays or changes.
80		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
81	=back	222	=back
		223
		224	=head1 API DOCUMENTATION
82		225
83	=head2 General API Considerations	226	=head2 General API Considerations
84		227
85	All objects (such as terminals, time watchers etc.) are typical	228	All objects (such as terminals, time watchers etc.) are typical
86	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
…		…
99	=over 4	242	=over 4
100		243
101	=item $text	244	=item $text
102		245
103	Rxvt-unicodes special way of encoding text, where one "unicode" character	246	Rxvt-unicodes special way of encoding text, where one "unicode" character
104	always represents one screen cell. See L<row_t> for a discussion of this format.	247	always represents one screen cell. See L<ROW_t> for a discussion of this format.
105		248
106	=item $string	249	=item $string
107		250
108	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
109	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
…		…
114	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
115	locale-specific way.	258	locale-specific way.
116		259
117	=back	260	=back
118		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
119	=head2 Hooks	295	=head2 Hooks
120		296
121	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
122	called whenever the relevant event happens.	298	called whenever the relevant event happens.
123		299
124	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
125	and extension package. You can call all C<urxvt::term> methods on it, but	301	the in the C<Extension Objects> section.
126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127	object that is shared between all packages is stored in the C<term>
128	member. It is, however, blessed intot he package of the extension script,
129	so for all practical purposes you can treat an extension script as a class.
130		302
131	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
132	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
133	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.
134		306
135	When in doubt, return a false value (preferably C<()>).	307	I<< When in doubt, return a false value (preferably C<()>). >>
136		308
137	=over 4	309	=over 4
138		310
139	=item on_init $term	311	=item on_init $term
140		312
…		…
175	=item on_sel_extend $term	347	=item on_sel_extend $term
176		348
177	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
178	click) and is either supposed to return false (normal operation), or	350	click) and is either supposed to return false (normal operation), or
179	should extend the selection itelf and return true to suppress the built-in	351	should extend the selection itelf and return true to suppress the built-in
180	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.
181		355
182	See the F<selection> example extension.	356	See the F<selection> example extension.
183		357
184	=item on_view_change $term, $offset	358	=item on_view_change $term, $offset
185		359
…		…
194	than the scroll back buffer or the terminal.	368	than the scroll back buffer or the terminal.
195		369
196	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,
197	$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
198	number of lines that will be in the scrollback buffer.	372	number of lines that will be in the scrollback buffer.
199
200	=item on_tty_activity $term NYI
201
202	Called whenever the program(s) running in the urxvt window send output.
203		373
204	=item on_osc_seq $term, $string	374	=item on_osc_seq $term, $string
205		375
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	376	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	377	operating system command) is processed. Cursor position and other state
…		…
220	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
221	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
222	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
223	output.	393	output.
224		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
225	=item on_line_update $term, $row	400	=item on_line_update $term, $row
226		401
227	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
228	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
229	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,
…		…
251		426
252	Called whenever the user presses a key combination that has a	427	Called whenever the user presses a key combination that has a
253	C<perl:string> action bound to it (see description of the B<keysym>	428	C<perl:string> action bound to it (see description of the B<keysym>
254	resource in the @@RXVT_NAME@@(1) manpage).	429	resource in the @@RXVT_NAME@@(1) manpage).
255		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
256	=item on_focus_in $term	437	=item on_focus_in $term
257		438
258	Called whenever the window gets the keyboard focus, before rxvt-unicode	439	Called whenever the window gets the keyboard focus, before rxvt-unicode
259	does focus in processing.	440	does focus in processing.
260		441
261	=item on_focus_out $term	442	=item on_focus_out $term
262		443
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	444	Called wheneever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	445	focus out processing.
265		446
		447	=item on_configure_notify $term, $event
		448
266	=item on_key_press $term, $event, $octets	449	=item on_key_press $term, $event, $keysym, $octets
267		450
268	=item on_key_release $term, $event	451	=item on_key_release $term, $event, $keysym
269		452
270	=item on_button_press $term, $event	453	=item on_button_press $term, $event
271		454
272	=item on_button_release $term, $event	455	=item on_button_release $term, $event
273		456
…		…
289		472
290	subwindow.	473	subwindow.
291		474
292	=back	475	=back
293		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
294	=head2 Variables in the C<urxvt> Package	498	=head2 Variables in the C<urxvt> Package
295		499
296	=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>.
297		514
298	=item $urxvt::TERM	515	=item $urxvt::TERM
299		516
300	The current terminal. This variable stores the current C<urxvt::term>	517	The current terminal. This variable stores the current C<urxvt::term>
301	object, whenever a callback/hook is executing.	518	object, whenever a callback/hook is executing.
…		…
303	=back	520	=back
304		521
305	=head2 Functions in the C<urxvt> Package	522	=head2 Functions in the C<urxvt> Package
306		523
307	=over 4	524	=over 4
308
309	=item $term = new urxvt [arg...]
310
311	Creates a new terminal, very similar as if you had started it with
312	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
313	if the new instance couldn't be created. Returns C<undef> if the new
314	instance didn't initialise perl, and the terminal object otherwise. The
315	C<init> and C<start> hooks will be called during the call.
316		525
317	=item urxvt::fatal $errormessage	526	=item urxvt::fatal $errormessage
318		527
319	Fatally aborts execution with the given error message. Avoid at all	528	Fatally aborts execution with the given error message. Avoid at all
320	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
…		…
327	that calls this function.	536	that calls this function.
328		537
329	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
330	correct place, e.g. on stderr of the connecting urxvtc client.	539	correct place, e.g. on stderr of the connecting urxvtc client.
331		540
		541	Messages have a size limit of 1023 bytes currently.
		542
332	=item $time = urxvt::NOW	543	=item $time = urxvt::NOW
333		544
334	Returns the "current time" (as per the event loop).	545	Returns the "current time" (as per the event loop).
335		546
336	=item urxvt::CurrentTime	547	=item urxvt::CurrentTime
337		548
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	549	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	550	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	551	Button4Mask, Button5Mask, AnyModifier
341		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
		568
342	Various constants for use in X events.	569	Various constants for use in X calls and event processing.
343		570
344	=back	571	=back
345		572
346	=head2 RENDITION	573	=head2 RENDITION
347		574
…		…
374		601
375	=item $background = urxvt::GET_BASEBG $rend	602	=item $background = urxvt::GET_BASEBG $rend
376		603
377	Return the foreground/background colour index, respectively.	604	Return the foreground/background colour index, respectively.
378		605
379	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
380		607
381	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	608	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
382		609
383	Replace the foreground/background colour in the rendition mask with the	610	Replace the foreground/background colour in the rendition mask with the
384	specified one.	611	specified one.
385		612
386	=item $value = urxvt::GET_CUSTOM ($rend)	613	=item $value = urxvt::GET_CUSTOM $rend
387		614
388	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
389	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
390	zero.	617	zero.
391		618
392	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	619	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
393		620
394	Change the custom value.	621	Change the custom value.
395		622
396	=back	623	=back
397		624
398	=cut	625	=cut
399		626
400	package urxvt;
401
402	use utf8;
403	use strict;
404	use Scalar::Util ();
405	use List::Util ();
406
407	our $TERM;
408	our @HOOKNAME;
409	our %OPTION;
410	our $LIBDIR;
411
412	BEGIN {	627	BEGIN {
413	urxvt->bootstrap;
414
415	# overwrite perl's warn	628	# overwrite perl's warn
416	*CORE::GLOBAL::warn = sub {	629	*CORE::GLOBAL::warn = sub {
417	my $msg = join "", @_;	630	my $msg = join "", @_;
418	$msg .= "\n"	631	$msg .= "\n"
419	unless $msg =~ /\n$/;	632	unless $msg =~ /\n$/;
420	urxvt::warn ($msg);	633	urxvt::warn ($msg);
421	};	634	};
422	}	635	}
423		636
424	my @hook_count;
425	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	637	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
426		638
427	sub verbose {	639	sub verbose {
428	my ($level, $msg) = @_;	640	my ($level, $msg) = @_;
429	warn "$msg\n" if $level <= $verbosity;	641	warn "$msg\n" if $level <= $verbosity;
430	}	642	}
431		643
432	# find on_xxx subs in the package and register them
433	# as hooks
434	sub register_package($) {
435	my ($pkg) = @_;
436
437	for my $htype (0.. $#HOOKNAME) {
438	my $name = $HOOKNAME[$htype];
439
440	my $ref = $pkg->can ("on_" . lc $name)
441	or next;
442
443	$TERM->{_hook}[$htype]{$pkg} = $ref;
444	$hook_count[$htype]++
445	or set_should_invoke $htype, 1;
446	}
447	}
448
449	my $extension_pkg = "extension0000";
450	my %extension_pkg;	644	my %extension_pkg;
451		645
452	# load a single script into its own package, once only	646	# load a single script into its own package, once only
453	sub extension_package($) {	647	sub extension_package($) {
454	my ($path) = @_;	648	my ($path) = @_;
455		649
		650	no strict 'refs';
		651
456	$extension_pkg{$path} \|\|= do {	652	$extension_pkg{$path} \|\|= do {
457	my $pkg = "urxvt::" . ($extension_pkg++);	653	$path =~ /([^\/\\]+)$/;
		654	my $pkg = $1;
		655	$pkg =~ s/[^[:word:]]/_/g;
		656	$pkg = "urxvt::ext::$pkg";
458		657
459	verbose 3, "loading extension '$path' into package '$pkg'";	658	verbose 3, "loading extension '$path' into package '$pkg'";
460		659
461	open my $fh, "<:raw", $path	660	open my $fh, "<:raw", $path
462	or die "$path: $!";	661	or die "$path: $!";
463		662
		663	@{"$pkg\::ISA"} = urxvt::term::extension::;
		664
		665	my $source =
464	my $source = "package $pkg; use strict; use utf8;\n"	666	"package $pkg; use strict; use utf8;\n"
465	. "use base urxvt::term::proxy::;\n"
466	. "#line 1 \"$path\"\n{\n"	667	. "#line 1 \"$path\"\n{\n"
467	. (do { local $/; <$fh> })	668	. (do { local $/; <$fh> })
468	. "\n};\n1";	669	. "\n};\n1";
469		670
		671	eval $source
470	eval $source or die "$path: $@";	672	or die "$path: $@";
471		673
472	$pkg	674	$pkg
473	}	675	}
474	}	676	}
475		677
…		…
481	my $htype = shift;	683	my $htype = shift;
482		684
483	if ($htype == 0) { # INIT	685	if ($htype == 0) { # INIT
484	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	686	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
485		687
486	my %want_ext;	688	my %ext_arg;
487		689
488	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	690	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
489	if ($_ eq "default") {	691	if ($_ eq "default") {
490	$want_ext{$_}++ for qw(selection option-popup);	692	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
491	} elsif (/^-(.*)$/) {	693	} elsif (/^-(.*)$/) {
492	delete $want_ext{$1};	694	delete $ext_arg{$1};
		695	} elsif (/^([^<]+)<(.*)>$/) {
		696	push @{ $ext_arg{$1} }, $2;
493	} else {	697	} else {
494	$want_ext{$_}++;	698	$ext_arg{$_} \|\|= [];
495	}	699	}
496	}	700	}
497		701
498	for my $ext (keys %want_ext) {	702	while (my ($ext, $argv) = each %ext_arg) {
499	my @files = grep -f $_, map "$_/$ext", @dirs;	703	my @files = grep -f $_, map "$_/$ext", @dirs;
500		704
501	if (@files) {	705	if (@files) {
502	register_package extension_package $files[0];	706	$TERM->register_package (extension_package $files[0], $argv);
503	} else {	707	} else {
504	warn "perl extension '$ext' not found in perl library search path\n";	708	warn "perl extension '$ext' not found in perl library search path\n";
505	}	709	}
506	}	710	}
		711
		712	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		713	warn $@ if $@;
507	}	714	}
508		715
509	$retval = undef;	716	$retval = undef;
510		717
511	if (my $cb = $TERM->{_hook}[$htype]) {	718	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
513	if $verbosity >= 10;	720	if $verbosity >= 10;
514		721
515	keys %$cb;	722	keys %$cb;
516		723
517	while (my ($pkg, $cb) = each %$cb) {	724	while (my ($pkg, $cb) = each %$cb) {
518	eval {	725	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
519	$retval = $cb->(
520	$TERM->{_pkg}{$pkg} \|\|= do {
521	my $proxy = bless { }, $pkg;
522	Scalar::Util::weaken ($proxy->{term} = $TERM);
523	$proxy
524	},
525	@_,
526	) and last;	726	and last;
527	};
528	warn $@ if $@;#d#
529	}
530	}
531		727
532	if ($htype == 1) { # DESTROY	728	if ($@) {
533	# remove hooks if unused	729	$TERM->ungrab; # better to lose the grab than the session
534	if (my $hook = $TERM->{_hook}) {	730	warn $@;
535	for my $htype (0..$#$hook) {
536	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
537	or set_should_invoke $htype, 0;
538	}	731	}
539	}	732	}
540		733
		734	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		735	if $verbosity >= 11;
		736	}
		737
		738	if ($htype == 1) { # DESTROY
541	# clear package objects	739	# clear package objects
542	%$_ = () for values %{ $TERM->{_pkg} };	740	%$_ = () for values %{ $TERM->{_pkg} };
543		741
544	# clear package	742	# clear package
545	%$TERM = ();	743	%$TERM = ();
546	}	744	}
547		745
548	$retval	746	$retval
549	}	747	}
550		748
551	sub urxvt::term::proxy::AUTOLOAD {	749	sub exec_async(@) {
552	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	750	my $pid = fork;
		751
		752	return
		753	if !defined $pid or $pid;
		754
		755	%ENV = %{ $TERM->env };
		756
		757	exec @_;
		758	_exit 255;
		759	}
		760
		761	# urxvt::term::extension
		762
		763	package urxvt::term::extension;
		764
		765	sub enable {
		766	my ($self, %hook) = @_;
		767	my $pkg = $self->{_pkg};
		768
		769	while (my ($name, $cb) = each %hook) {
		770	my $htype = $HOOKTYPE{uc $name};
		771	defined $htype
		772	or Carp::croak "unsupported hook type '$name'";
		773
		774	$self->set_should_invoke ($htype, +1)
		775	unless exists $self->{term}{_hook}[$htype]{$pkg};
		776
		777	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		778	}
		779	}
		780
		781	sub disable {
		782	my ($self, @hook) = @_;
		783	my $pkg = $self->{_pkg};
		784
		785	for my $name (@hook) {
		786	my $htype = $HOOKTYPE{uc $name};
		787	defined $htype
		788	or Carp::croak "unsupported hook type '$name'";
		789
		790	$self->set_should_invoke ($htype, -1)
		791	if delete $self->{term}{_hook}[$htype]{$pkg};
		792	}
		793	}
		794
		795	our $AUTOLOAD;
		796
		797	sub AUTOLOAD {
		798	$AUTOLOAD =~ /:([^:]+)$/
553	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	799	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
554		800
555	eval qq{	801	eval qq{
556	sub $urxvt::term::proxy::AUTOLOAD {	802	sub $AUTOLOAD {
557	my \$proxy = shift;	803	my \$proxy = shift;
558	\$proxy->{term}->$1 (\@_)	804	\$proxy->{term}->$1 (\@_)
559	}	805	}
560	1	806	1
561	} or die "FATAL: unable to compile method forwarder: $@";	807	} or die "FATAL: unable to compile method forwarder: $@";
562		808
563	goto &$urxvt::term::proxy::AUTOLOAD;	809	goto &$AUTOLOAD;
564	}	810	}
		811
		812	sub DESTROY {
		813	# nop
		814	}
		815
		816	# urxvt::destroy_hook
565		817
566	sub urxvt::destroy_hook::DESTROY {	818	sub urxvt::destroy_hook::DESTROY {
567	${$_[0]}->();	819	${$_[0]}->();
568	}	820	}
569		821
570	sub urxvt::destroy_hook(&) {	822	sub urxvt::destroy_hook(&) {
571	bless \shift, urxvt::destroy_hook::	823	bless \shift, urxvt::destroy_hook::
572	}	824	}
573		825
		826	package urxvt::anyevent;
		827
		828	=head2 The C<urxvt::anyevent> Class
		829
		830	The sole purpose of this class is to deliver an interface to the
		831	C<AnyEvent> module - any module using it will work inside urxvt without
		832	further programming. The only exception is that you cannot wait on
		833	condition variables, but non-blocking condvar use is ok. What this means
		834	is that you cannot use blocking APIs, but the non-blocking variant should
		835	work.
		836
		837	=cut
		838
		839	our $VERSION = 1;
		840
		841	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		842	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		843
		844	sub timer {
		845	my ($class, %arg) = @_;
		846
		847	my $cb = $arg{cb};
		848
		849	urxvt::timer
		850	->new
		851	->start (urxvt::NOW + $arg{after})
		852	->cb (sub {
		853	$_[0]->stop; # need to cancel manually
		854	$cb->();
		855	})
		856	}
		857
		858	sub io {
		859	my ($class, %arg) = @_;
		860
		861	my $cb = $arg{cb};
		862
		863	bless [$arg{fh}, urxvt::iow
		864	->new
		865	->fd (fileno $arg{fh})
		866	->events (($arg{poll} =~ /r/ ? 1 : 0)
		867	\| ($arg{poll} =~ /w/ ? 2 : 0))
		868	->start
		869	->cb (sub {
		870	$cb->(($_[1] & 1 ? 'r' : '')
		871	. ($_[1] & 2 ? 'w' : ''));
		872	})],
		873	urxvt::anyevent::
		874	}
		875
		876	sub DESTROY {
		877	$_[0][1]->stop;
		878	}
		879
		880	sub condvar {
		881	bless \my $flag, urxvt::anyevent::condvar::
		882	}
		883
		884	sub urxvt::anyevent::condvar::broadcast {
		885	${$_[0]}++;
		886	}
		887
		888	sub urxvt::anyevent::condvar::wait {
		889	unless (${$_[0]}) {
		890	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		891	}
		892	}
		893
		894	package urxvt::term;
		895
574	=head2 The C<urxvt::term> Class	896	=head2 The C<urxvt::term> Class
575		897
576	=over 4	898	=over 4
577		899
		900	=cut
		901
		902	# find on_xxx subs in the package and register them
		903	# as hooks
		904	sub register_package {
		905	my ($self, $pkg, $argv) = @_;
		906
		907	my $proxy = bless {
		908	_pkg => $pkg,
		909	argv => $argv,
		910	}, $pkg;
		911	Scalar::Util::weaken ($proxy->{term} = $self);
		912
		913	$self->{_pkg}{$pkg} = $proxy;
		914
		915	for my $name (@HOOKNAME) {
		916	if (my $ref = $pkg->can ("on_" . lc $name)) {
		917	$proxy->enable ($name => $ref);
		918	}
		919	}
		920	}
		921
		922	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		923
		924	Creates a new terminal, very similar as if you had started it with system
		925	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		926	hash which defines the environment of the new terminal.
		927
		928	Croaks (and probably outputs an error message) if the new instance
		929	couldn't be created. Returns C<undef> if the new instance didn't
		930	initialise perl, and the terminal object otherwise. The C<init> and
		931	C<start> hooks will be called during this call.
		932
		933	=cut
		934
		935	sub new {
		936	my ($class, $env, @args) = @_;
		937
		938	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		939	}
		940
578	=item $term->destroy	941	=item $term->destroy
579		942
580	Destroy the terminal object (close the window, free resources etc.).	943	Destroy the terminal object (close the window, free resources
		944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		945	watchers (timers, io watchers) are still active.
581		946
582	=item $isset = $term->option ($optval[, $set])	947	=item $isset = $term->option ($optval[, $set])
583		948
584	Returns true if the option specified by C<$optval> is enabled, and	949	Returns true if the option specified by C<$optval> is enabled, and
585	optionally change it. All option values are stored by name in the hash	950	optionally change it. All option values are stored by name in the hash
…		…
588	Here is a a likely non-exhaustive list of option names, please see the	953	Here is a a likely non-exhaustive list of option names, please see the
589	source file F</src/optinc.h> to see the actual list:	954	source file F</src/optinc.h> to see the actual list:
590		955
591	borderLess console cursorBlink cursorUnderline hold iconic insecure	956	borderLess console cursorBlink cursorUnderline hold iconic insecure
592	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	957	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
593	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	958	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
594	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	959	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
595	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	960	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
596	tripleclickwords utmpInhibit visualBell	961	transparent tripleclickwords utmpInhibit visualBell
597		962
598	=item $value = $term->resource ($name[, $newval])	963	=item $value = $term->resource ($name[, $newval])
599		964
600	Returns the current resource value associated with a given name and	965	Returns the current resource value associated with a given name and
601	optionally sets a new value. Setting values is most useful in the C<init>	966	optionally sets a new value. Setting values is most useful in the C<init>
…		…
618		983
619	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	984	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
620	borderLess color cursorBlink cursorUnderline cutchars delete_key	985	borderLess color cursorBlink cursorUnderline cutchars delete_key
621	display_name embed ext_bwidth fade font geometry hold iconName	986	display_name embed ext_bwidth fade font geometry hold iconName
622	imFont imLocale inputMethod insecure int_bwidth intensityStyles	987	imFont imLocale inputMethod insecure int_bwidth intensityStyles
623	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	988	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
624	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	989	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
625	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	990	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
626	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	991	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
627	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	992	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
628	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	993	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
629	shade term_name title transparent transparent_all tripleclickwords	994	secondaryScreen secondaryScroll selectstyle shade term_name title
630	utmpInhibit visualBell	995	transient_for transparent transparent_all tripleclickwords utmpInhibit
		996	visualBell
631		997
632	=cut	998	=cut
633		999
634	sub urxvt::term::resource($$;$) {	1000	sub resource($$;$) {
635	my ($self, $name) = (shift, shift);	1001	my ($self, $name) = (shift, shift);
636	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1002	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
637	&urxvt::term::_resource	1003	&urxvt::term::_resource
638	}	1004	}
639		1005
		1006	=item $value = $term->x_resource ($pattern)
		1007
		1008	Returns the X-Resource for the given pattern, excluding the program or
		1009	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1010	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1011	resource with that pattern exists.
		1012
		1013	This method should only be called during the C<on_start> hook, as there is
		1014	only one resource database per display, and later invocations might return
		1015	the wrong resources.
		1016
		1017	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1018
		1019	Adds a keymap translation exactly as specified via a resource. See the
		1020	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1021
640	=item $rend = $term->rstyle ([$new_rstyle])	1022	=item $rend = $term->rstyle ([$new_rstyle])
641		1023
642	Return and optionally change the current rendition. Text that is output by	1024	Return and optionally change the current rendition. Text that is output by
643	the terminal application will use this style.	1025	the terminal application will use this style.
644		1026
…		…
654	=item ($row, $col) = $term->selection_end ([$row, $col])	1036	=item ($row, $col) = $term->selection_end ([$row, $col])
655		1037
656	Return the current values of the selection mark, begin or end positions,	1038	Return the current values of the selection mark, begin or end positions,
657	and optionally set them to new values.	1039	and optionally set them to new values.
658		1040
		1041	=item $term->selection_make ($eventtime[, $rectangular])
		1042
		1043	Tries to make a selection as set by C<selection_beg> and
		1044	C<selection_end>. If C<$rectangular> is true (default: false), a
		1045	rectangular selection will be made. This is the prefered function to make
		1046	a selection.
		1047
659	=item $success = $term->selection_grab ($eventtime)	1048	=item $success = $term->selection_grab ($eventtime)
660		1049
661	Try to request the primary selection from the server (for example, as set	1050	Try to request the primary selection text from the server (for example, as
662	by the next method).	1051	set by the next method). No visual feedback will be given. This function
		1052	is mostly useful from within C<on_sel_grab> hooks.
663		1053
664	=item $oldtext = $term->selection ([$newtext])	1054	=item $oldtext = $term->selection ([$newtext])
665		1055
666	Return the current selection text and optionally replace it by C<$newtext>.	1056	Return the current selection text and optionally replace it by C<$newtext>.
667		1057
668	#=item $term->overlay ($x, $y, $text)	1058	=item $term->overlay_simple ($x, $y, $text)
669	#	1059
670	#Create a simple multi-line overlay box. See the next method for details.	1060	Create a simple multi-line overlay box. See the next method for details.
671	#	1061
672	#=cut	1062	=cut
673	#	1063
674	#sub urxvt::term::scr_overlay {	1064	sub overlay_simple {
675	# my ($self, $x, $y, $text) = @_;	1065	my ($self, $x, $y, $text) = @_;
676	#	1066
677	# my @lines = split /\n/, $text;	1067	my @lines = split /\n/, $text;
678	#	1068
679	# my $w = 0;	1069	my $w = List::Util::max map $self->strwidth ($_), @lines;
680	# for (map $self->strwidth ($_), @lines) {	1070
681	# $w = $_ if $w < $_;
682	# }
683	#
684	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1071	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
685	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1072	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
686	#}	1073
		1074	$overlay
		1075	}
687		1076
688	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1077	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
689		1078
690	Create a new (empty) overlay at the given position with the given	1079	Create a new (empty) overlay at the given position with the given
691	width/height. C<$rstyle> defines the initial rendition style	1080	width/height. C<$rstyle> defines the initial rendition style
…		…
726	C<$event> I<must> be the event causing the menu to pop up (a button event,	1115	C<$event> I<must> be the event causing the menu to pop up (a button event,
727	currently).	1116	currently).
728		1117
729	=cut	1118	=cut
730		1119
731	sub urxvt::term::popup {	1120	sub popup {
732	my ($self, $event) = @_;	1121	my ($self, $event) = @_;
733		1122
734	$self->grab ($event->{time}, 1)	1123	$self->grab ($event->{time}, 1)
735	or return;	1124	or return;
736		1125
…		…
758		1147
759	=item $string = $term->locale_decode ($octets)	1148	=item $string = $term->locale_decode ($octets)
760		1149
761	Convert the given locale-encoded octets into a perl string.	1150	Convert the given locale-encoded octets into a perl string.
762		1151
		1152	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1153
		1154	XORs the rendition values in the given span with the provided value
		1155	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1156	refresh hooks to provide effects similar to the selection.
		1157
		1158	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1159
		1160	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1161	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1162	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1163	it instead. Both styles I<MUST NOT> contain font styles.
		1164
		1165	=item $term->scr_bell
		1166
		1167	Ring the bell!
		1168
763	=item $term->scr_add_lines ($string)	1169	=item $term->scr_add_lines ($string)
764		1170
765	Write the given text string to the screen, as if output by the application	1171	Write the given text string to the screen, as if output by the application
766	running inside the terminal. It may not contain command sequences (escape	1172	running inside the terminal. It may not contain command sequences (escape
767	codes), but is free to use line feeds, carriage returns and tabs. The	1173	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
781		1187
782	Write the octets given in C<$data> to the tty (i.e. as program input). To	1188	Write the octets given in C<$data> to the tty (i.e. as program input). To
783	pass characters instead of octets, you should convert your strings first	1189	pass characters instead of octets, you should convert your strings first
784	to the locale-specific encoding using C<< $term->locale_encode >>.	1190	to the locale-specific encoding using C<< $term->locale_encode >>.
785		1191
		1192	=item $old_events = $term->pty_ev_events ([$new_events])
		1193
		1194	Replaces the event mask of the pty watcher by the given event mask. Can
		1195	be used to suppress input and output handling to the pty/tty. See the
		1196	description of C<< urxvt::timer->events >>. Make sure to always restore
		1197	the previous value.
		1198
786	=item $windowid = $term->parent	1199	=item $windowid = $term->parent
787		1200
788	Return the window id of the toplevel window.	1201	Return the window id of the toplevel window.
789		1202
790	=item $windowid = $term->vt	1203	=item $windowid = $term->vt
791		1204
792	Return the window id of the terminal window.	1205	Return the window id of the terminal window.
793		1206
		1207	=item $term->vt_emask_add ($x_event_mask)
		1208
		1209	Adds the specified events to the vt event mask. Useful e.g. when you want
		1210	to receive pointer events all the times:
		1211
		1212	$term->vt_emask_add (urxvt::PointerMotionMask);
		1213
794	=item $window_width = $term->width	1214	=item $window_width = $term->width
795		1215
796	=item $window_height = $term->height	1216	=item $window_height = $term->height
797		1217
798	=item $font_width = $term->fwidth	1218	=item $font_width = $term->fwidth
…		…
811		1231
812	=item $max_scrollback = $term->saveLines	1232	=item $max_scrollback = $term->saveLines
813		1233
814	=item $nrow_plus_saveLines = $term->total_rows	1234	=item $nrow_plus_saveLines = $term->total_rows
815		1235
816	=item $lines_in_scrollback = $term->nsaved	1236	=item $topmost_scrollback_row = $term->top_row
817		1237
818	Return various integers describing terminal characteristics.	1238	Return various integers describing terminal characteristics.
		1239
		1240	=item $x_display = $term->display_id
		1241
		1242	Return the DISPLAY used by rxvt-unicode.
		1243
		1244	=item $lc_ctype = $term->locale
		1245
		1246	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1247
		1248	=item $env = $term->env
		1249
		1250	Returns a copy of the environment in effect for the terminal as a hashref
		1251	similar to C<\%ENV>.
		1252
		1253	=cut
		1254
		1255	sub env {
		1256	if (my $env = $_[0]->_env) {
		1257	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1258	} else {
		1259	+{ %ENV }
		1260	}
		1261	}
819		1262
820	=item $modifiermask = $term->ModLevel3Mask	1263	=item $modifiermask = $term->ModLevel3Mask
821		1264
822	=item $modifiermask = $term->ModMetaMask	1265	=item $modifiermask = $term->ModMetaMask
823		1266
…		…
826	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1269	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
827	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1270	AltGr), the meta key (often Alt) and the num lock key, if applicable.
828		1271
829	=item $view_start = $term->view_start ([$newvalue])	1272	=item $view_start = $term->view_start ([$newvalue])
830		1273
831	Returns the negative row number of the topmost line. Minimum value is	1274	Returns the row number of the topmost displayed line. Maximum value is
832	C<0>, which displays the normal terminal contents. Larger values scroll	1275	C<0>, which displays the normal terminal contents. Lower values scroll
833	this many lines into the scrollback buffer.	1276	this many lines into the scrollback buffer.
834		1277
835	=item $term->want_refresh	1278	=item $term->want_refresh
836		1279
837	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1280	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
916	Return the row number of the first/last row of the line, respectively.	1359	Return the row number of the first/last row of the line, respectively.
917		1360
918	=item $offset = $line->offset_of ($row, $col)	1361	=item $offset = $line->offset_of ($row, $col)
919		1362
920	Returns the character offset of the given row\|col pair within the logical	1363	Returns the character offset of the given row\|col pair within the logical
921	line.	1364	line. Works for rows outside the line, too, and returns corresponding
		1365	offsets outside the string.
922		1366
923	=item ($row, $col) = $line->coord_of ($offset)	1367	=item ($row, $col) = $line->coord_of ($offset)
924		1368
925	Translates a string offset into terminal coordinates again.	1369	Translates a string offset into terminal coordinates again.
926		1370
927	=back	1371	=back
928		1372
929	=cut	1373	=cut
930		1374
931	sub urxvt::term::line {	1375	sub line {
932	my ($self, $row) = @_;	1376	my ($self, $row) = @_;
933		1377
934	my $maxrow = $self->nrow - 1;	1378	my $maxrow = $self->nrow - 1;
935		1379
936	my ($beg, $end) = ($row, $row);	1380	my ($beg, $end) = ($row, $row);
…		…
1000	$offset / $self->{ncol} + $self->{beg},	1444	$offset / $self->{ncol} + $self->{beg},
1001	$offset % $self->{ncol}	1445	$offset % $self->{ncol}
1002	)	1446	)
1003	}	1447	}
1004		1448
1005	=item ($row, $col) = $line->coord_of ($offset)
1006	=item $text = $term->special_encode $string	1449	=item $text = $term->special_encode $string
1007		1450
1008	Converts a perl string into the special encoding used by rxvt-unicode,	1451	Converts a perl string into the special encoding used by rxvt-unicode,
1009	where one character corresponds to one screen cell. See	1452	where one character corresponds to one screen cell. See
1010	C<< $term->ROW_t >> for details.	1453	C<< $term->ROW_t >> for details.
…		…
1012	=item $string = $term->special_decode $text	1455	=item $string = $term->special_decode $text
1013		1456
1014	Converts rxvt-unicodes text reprsentation into a perl string. See	1457	Converts rxvt-unicodes text reprsentation into a perl string. See
1015	C<< $term->ROW_t >> for details.	1458	C<< $term->ROW_t >> for details.
1016		1459
		1460	=item $success = $term->grab_button ($button, $modifiermask)
		1461
		1462	Registers a synchronous button grab. See the XGrabButton manpage.
		1463
		1464	=item $success = $term->grab ($eventtime[, $sync])
		1465
		1466	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1467	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1468
		1469	=item $term->allow_events_async
		1470
		1471	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1472
		1473	=item $term->allow_events_sync
		1474
		1475	Calls XAllowEvents with SyncBoth for the most recent grab.
		1476
		1477	=item $term->allow_events_replay
		1478
		1479	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1480	recent grab.
		1481
		1482	=item $term->ungrab
		1483
		1484	Calls XUngrab for the most recent grab. Is called automatically on
		1485	evaluation errors, as it is better to lose the grab in the error case as
		1486	the session.
		1487
1017	=back	1488	=back
1018		1489
		1490	=cut
		1491
		1492	package urxvt::popup;
		1493
1019	=head2 The C<urxvt::popup> Class	1494	=head2 The C<urxvt::popup> Class
1020		1495
1021	=over 4	1496	=over 4
1022		1497
1023	=cut	1498	=cut
1024
1025	package urxvt::popup;
1026		1499
1027	sub add_item {	1500	sub add_item {
1028	my ($self, $item) = @_;	1501	my ($self, $item) = @_;
1029		1502
1030	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};	1503	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
…		…
1034	$item->{render} \|\|= sub { $_[0]{text} };	1507	$item->{render} \|\|= sub { $_[0]{text} };
1035		1508
1036	push @{ $self->{item} }, $item;	1509	push @{ $self->{item} }, $item;
1037	}	1510	}
1038		1511
1039	sub add_separator {	1512	=item $popup->add_title ($title)
1040	my ($self, $sep) = @_;
1041		1513
1042	$sep \|\|= "═";	1514	Adds a non-clickable title to the popup.
1043		1515
1044	$self->add_item ({	1516	=cut
1045	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1046	text => "",
1047	render => sub { $sep x $urxvt::TERM->ncol },
1048	activate => sub { },
1049	});
1050	}
1051		1517
1052	sub add_title {	1518	sub add_title {
1053	my ($self, $title) = @_;	1519	my ($self, $title) = @_;
1054		1520
1055	$self->add_item ({	1521	$self->add_item ({
…		…
1057	text => $title,	1523	text => $title,
1058	activate => sub { },	1524	activate => sub { },
1059	});	1525	});
1060	}	1526	}
1061		1527
		1528	=item $popup->add_separator ([$sepchr])
		1529
		1530	Creates a separator, optionally using the character given as C<$sepchr>.
		1531
		1532	=cut
		1533
		1534	sub add_separator {
		1535	my ($self, $sep) = @_;
		1536
		1537	$sep \|\|= "=";
		1538
		1539	$self->add_item ({
		1540	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1541	text => "",
		1542	render => sub { $sep x $self->{term}->ncol },
		1543	activate => sub { },
		1544	});
		1545	}
		1546
		1547	=item $popup->add_button ($text, $cb)
		1548
		1549	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1550	selected.
		1551
		1552	=cut
		1553
1062	sub add_button {	1554	sub add_button {
1063	my ($self, $text, $cb) = @_;	1555	my ($self, $text, $cb) = @_;
1064		1556
1065	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1557	$self->add_item ({ type => "button", text => $text, activate => $cb});
1066	}	1558	}
		1559
		1560	=item $popup->add_toggle ($text, $cb, $initial_value)
		1561
		1562	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1563	whenever it gets toggled, with a boolean indicating its value as its first
		1564	argument.
		1565
		1566	=cut
1067		1567
1068	sub add_toggle {	1568	sub add_toggle {
1069	my ($self, $text, $cb, $value) = @_;	1569	my ($self, $text, $cb, $value) = @_;
1070		1570
1071	my $item; $item = {	1571	my $item; $item = {
1072	type => "button",	1572	type => "button",
1073	text => " $text",	1573	text => " $text",
1074	value => $value,	1574	value => $value,
1075	render => sub { ($item->{value} ? "* " : " ") . $text },	1575	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1076	activate => sub { $cb->($item->{value} = !$item->{value}); },	1576	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1077	};	1577	};
1078		1578
1079	$self->add_item ($item);	1579	$self->add_item ($item);
1080	}	1580	}
		1581
		1582	=item $popup->show
		1583
		1584	Displays the popup (which is initially hidden).
		1585
		1586	=cut
1081		1587
1082	sub show {	1588	sub show {
1083	my ($self) = @_;	1589	my ($self) = @_;
1084		1590
1085	local $urxvt::popup::self = $self;	1591	local $urxvt::popup::self = $self;
1086		1592
1087	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1593	my $env = $self->{term}->env;
		1594	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1595	delete $env->{LC_ALL};
		1596	$env->{LC_CTYPE} = $self->{term}->locale;
		1597
		1598	urxvt::term->new ($env, "popup",
		1599	"--perl-lib" => "", "--perl-ext-common" => "",
		1600	"-pty-fd" => -1, "-sl" => 0,
		1601	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1088	"--transient-for" => $self->{term}->parent,	1602	"--transient-for" => $self->{term}->parent,
		1603	"-display" => $self->{term}->display_id,
1089	"-pe" => "urxvt-popup")	1604	"-pe" => "urxvt-popup")
1090	or die "unable to create popup window\n";	1605	or die "unable to create popup window\n";
1091	}	1606	}
1092		1607
1093	sub DESTROY {	1608	sub DESTROY {
1094	my ($self) = @_;	1609	my ($self) = @_;
1095		1610
		1611	delete $self->{term}{_destroy}{$self};
1096	$self->{term}->ungrab;	1612	$self->{term}->ungrab;
1097	}	1613	}
		1614
		1615	=back
1098		1616
1099	=head2 The C<urxvt::timer> Class	1617	=head2 The C<urxvt::timer> Class
1100		1618
1101	This class implements timer watchers/events. Time is represented as a	1619	This class implements timer watchers/events. Time is represented as a
1102	fractional number of seconds since the epoch. Example:	1620	fractional number of seconds since the epoch. Example:
…		…
1141		1659
1142	=item $timer = $timer->start ($tstamp)	1660	=item $timer = $timer->start ($tstamp)
1143		1661
1144	Set the event trigger time to C<$tstamp> and start the timer.	1662	Set the event trigger time to C<$tstamp> and start the timer.
1145		1663
		1664	=item $timer = $timer->after ($delay)
		1665
		1666	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1667
1146	=item $timer = $timer->stop	1668	=item $timer = $timer->stop
1147		1669
1148	Stop the timer.	1670	Stop the timer.
1149		1671
1150	=back	1672	=back
…		…
1155		1677
1156	$term->{socket} = ...	1678	$term->{socket} = ...
1157	$term->{iow} = urxvt::iow	1679	$term->{iow} = urxvt::iow
1158	->new	1680	->new
1159	->fd (fileno $term->{socket})	1681	->fd (fileno $term->{socket})
1160	->events (1) # wait for read data	1682	->events (urxvt::EVENT_READ)
1161	->start	1683	->start
1162	->cb (sub {	1684	->cb (sub {
1163	my ($iow, $revents) = @_;	1685	my ($iow, $revents) = @_;
1164	# $revents must be 1 here, no need to check	1686	# $revents must be 1 here, no need to check
1165	sysread $term->{socket}, my $buf, 8192	1687	sysread $term->{socket}, my $buf, 8192
…		…
1182		1704
1183	Set the filedescriptor (not handle) to watch.	1705	Set the filedescriptor (not handle) to watch.
1184		1706
1185	=item $iow = $iow->events ($eventmask)	1707	=item $iow = $iow->events ($eventmask)
1186		1708
1187	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1709	Set the event mask to watch. The only allowed values are
1188	data, Bit #1 (value C<2>) enables watching for write data.	1710	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1711	together, or C<urxvt::EVENT_NONE>.
1189		1712
1190	=item $iow = $iow->start	1713	=item $iow = $iow->start
1191		1714
1192	Start watching for requested events on the given handle.	1715	Start watching for requested events on the given handle.
1193		1716
…		…
1204	This variable controls the verbosity level of the perl extension. Higher	1727	This variable controls the verbosity level of the perl extension. Higher
1205	numbers indicate more verbose output.	1728	numbers indicate more verbose output.
1206		1729
1207	=over 4	1730	=over 4
1208		1731
1209	=item =0 - only fatal messages	1732	=item == 0 - fatal messages
1210		1733
1211	=item =3 - script loading and management	1734	=item >= 3 - script loading and management
1212		1735
1213	=item =10 - all events received	1736	=item >=10 - all called hooks
		1737
		1738	=item >=11 - hook reutrn values
1214		1739
1215	=back	1740	=back
1216		1741
1217	=head1 AUTHOR	1742	=head1 AUTHOR
1218		1743

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.53 by root, Sun Jan 8 01:16:09 2006 UTC vs. Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.53 by root, Sun Jan 8 01:16:09 2006 UTC vs.
Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC