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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.45 by root, Sat Jan 7 20:23:52 2006 UTC vs.
Revision 1.105 by root, Wed Jan 18 19:43:51 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).
		546
		547	=item urxvt::CurrentTime
		548
		549	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		550	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		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
		568
		569	Various constants for use in X calls and event processing.
335		570
336	=back	571	=back
337		572
338	=head2 RENDITION	573	=head2 RENDITION
339		574
…		…
366		601
367	=item $background = urxvt::GET_BASEBG $rend	602	=item $background = urxvt::GET_BASEBG $rend
368		603
369	Return the foreground/background colour index, respectively.	604	Return the foreground/background colour index, respectively.
370		605
371	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
372		607
373	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	608	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
374		609
375	Replace the foreground/background colour in the rendition mask with the	610	Replace the foreground/background colour in the rendition mask with the
376	specified one.	611	specified one.
377		612
378	=item $value = urxvt::GET_CUSTOM ($rend)	613	=item $value = urxvt::GET_CUSTOM $rend
379		614
380	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
381	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
382	zero.	617	zero.
383		618
384	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	619	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
385		620
386	Change the custom value.	621	Change the custom value.
387		622
388	=back	623	=back
389		624
390	=cut	625	=cut
391		626
392	package urxvt;
393
394	use strict;
395	use Scalar::Util ();
396
397	our $TERM;
398	our @HOOKNAME;
399	our $LIBDIR;
400
401	BEGIN {	627	BEGIN {
402	urxvt->bootstrap;
403
404	# overwrite perl's warn	628	# overwrite perl's warn
405	*CORE::GLOBAL::warn = sub {	629	*CORE::GLOBAL::warn = sub {
406	my $msg = join "", @_;	630	my $msg = join "", @_;
407	$msg .= "\n"	631	$msg .= "\n"
408	unless $msg =~ /\n$/;	632	unless $msg =~ /\n$/;
409	urxvt::warn ($msg);	633	urxvt::warn ($msg);
410	};	634	};
411	}
412		635
413	my @hook_count;	636	# %ENV is the original startup environment
		637	delete $ENV{IFS};
		638	delete $ENV{CDPATH};
		639	delete $ENV{BASH_ENV};
		640	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
		641	}
		642
414	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	643	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
415		644
416	sub verbose {	645	sub verbose {
417	my ($level, $msg) = @_;	646	my ($level, $msg) = @_;
418	warn "$msg\n" if $level <= $verbosity;	647	warn "$msg\n" if $level <= $verbosity;
419	}	648	}
420		649
421	# find on_xxx subs in the package and register them
422	# as hooks
423	sub register_package($) {
424	my ($pkg) = @_;
425
426	for my $htype (0.. $#HOOKNAME) {
427	my $name = $HOOKNAME[$htype];
428
429	my $ref = $pkg->can ("on_" . lc $name)
430	or next;
431
432	$TERM->{_hook}[$htype]{$pkg} = $ref;
433	$hook_count[$htype]++
434	or set_should_invoke $htype, 1;
435	}
436	}
437
438	my $extension_pkg = "extension0000";
439	my %extension_pkg;	650	my %extension_pkg;
440		651
441	# load a single script into its own package, once only	652	# load a single script into its own package, once only
442	sub extension_package($) {	653	sub extension_package($) {
443	my ($path) = @_;	654	my ($path) = @_;
444		655
		656	no strict 'refs';
		657
445	$extension_pkg{$path} \|\|= do {	658	$extension_pkg{$path} \|\|= do {
446	my $pkg = "urxvt::" . ($extension_pkg++);	659	$path =~ /([^\/\\]+)$/;
		660	my $pkg = $1;
		661	$pkg =~ s/[^[:word:]]/_/g;
		662	$pkg = "urxvt::ext::$pkg";
447		663
448	verbose 3, "loading extension '$path' into package '$pkg'";	664	verbose 3, "loading extension '$path' into package '$pkg'";
449		665
450	open my $fh, "<:raw", $path	666	open my $fh, "<:raw", $path
451	or die "$path: $!";	667	or die "$path: $!";
452		668
		669	@{"$pkg\::ISA"} = urxvt::term::extension::;
		670
		671	my $source =
453	my $source = "package $pkg; use strict; use utf8;\n"	672	"package $pkg; use strict; use utf8;\n"
454	. "use base urxvt::term::proxy::;\n"
455	. "#line 1 \"$path\"\n{\n"	673	. "#line 1 \"$path\"\n{\n"
456	. (do { local $/; <$fh> })	674	. (do { local $/; <$fh> })
457	. "\n};\n1";	675	. "\n};\n1";
458		676
		677	eval $source
459	eval $source or die "$path: $@";	678	or die "$path: $@";
460		679
461	$pkg	680	$pkg
462	}	681	}
463	}	682	}
464		683
…		…
469	local $TERM = shift;	688	local $TERM = shift;
470	my $htype = shift;	689	my $htype = shift;
471		690
472	if ($htype == 0) { # INIT	691	if ($htype == 0) { # INIT
473	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	692	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		693
		694	my %ext_arg;
474		695
475	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	696	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		697	if ($_ eq "default") {
		698	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		699	} elsif (/^-(.*)$/) {
		700	delete $ext_arg{$1};
		701	} elsif (/^([^<]+)<(.*)>$/) {
		702	push @{ $ext_arg{$1} }, $2;
		703	} else {
		704	$ext_arg{$_} \|\|= [];
		705	}
		706	}
		707
		708	while (my ($ext, $argv) = each %ext_arg) {
476	my @files = grep -f $_, map "$_/$ext", @dirs;	709	my @files = grep -f $_, map "$_/$ext", @dirs;
477		710
478	if (@files) {	711	if (@files) {
479	register_package extension_package $files[0];	712	$TERM->register_package (extension_package $files[0], $argv);
480	} else {	713	} else {
481	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";
482	}	715	}
483	}	716	}
		717
		718	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		719	warn $@ if $@;
484	}	720	}
485		721
486	$retval = undef;	722	$retval = undef;
487		723
488	if (my $cb = $TERM->{_hook}[$htype]) {	724	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
490	if $verbosity >= 10;	726	if $verbosity >= 10;
491		727
492	keys %$cb;	728	keys %$cb;
493		729
494	while (my ($pkg, $cb) = each %$cb) {	730	while (my ($pkg, $cb) = each %$cb) {
495	eval {	731	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
496	$retval = $cb->(
497	$TERM->{_pkg}{$pkg} \|\|= do {
498	my $proxy = bless { }, $pkg;
499	Scalar::Util::weaken ($proxy->{term} = $TERM);
500	$proxy
501	},
502	@_,
503	) and last;	732	and last;
504	};
505	warn $@ if $@;#d#
506	}
507	}
508		733
509	if ($htype == 1) { # DESTROY	734	if ($@) {
510	# remove hooks if unused	735	$TERM->ungrab; # better to lose the grab than the session
511	if (my $hook = $TERM->{_hook}) {	736	warn $@;
512	for my $htype (0..$#$hook) {
513	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
514	or set_should_invoke $htype, 0;
515	}	737	}
516	}	738	}
517		739
		740	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		741	if $verbosity >= 11;
		742	}
		743
		744	if ($htype == 1) { # DESTROY
518	# clear package objects	745	# clear package objects
519	%$_ = () for values %{ $TERM->{_pkg} };	746	%$_ = () for values %{ $TERM->{_pkg} };
520		747
521	# clear package	748	# clear package
522	%$TERM = ();	749	%$TERM = ();
523	}	750	}
524		751
525	$retval	752	$retval
526	}	753	}
527		754
528	sub urxvt::term::proxy::AUTOLOAD {	755	sub exec_async(@) {
529	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	756	my $pid = fork;
		757
		758	return
		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 =~ /:([^:]+)$/
530	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	805	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
531		806
532	eval qq{	807	eval qq{
533	sub $urxvt::term::proxy::AUTOLOAD {	808	sub $AUTOLOAD {
534	my \$proxy = shift;	809	my \$proxy = shift;
535	\$proxy->{term}->$1 (\@_)	810	\$proxy->{term}->$1 (\@_)
536	}	811	}
537	1	812	1
538	} or die "FATAL: unable to compile method forwarder: $@";	813	} or die "FATAL: unable to compile method forwarder: $@";
539		814
540	goto &$urxvt::term::proxy::AUTOLOAD;	815	goto &$AUTOLOAD;
541	}	816	}
		817
		818	sub DESTROY {
		819	# nop
		820	}
		821
		822	# urxvt::destroy_hook
542		823
543	sub urxvt::destroy_hook::DESTROY {	824	sub urxvt::destroy_hook::DESTROY {
544	${$_[0]}->();	825	${$_[0]}->();
545	}	826	}
546		827
547	sub urxvt::destroy_hook(&) {	828	sub urxvt::destroy_hook(&) {
548	bless \shift, urxvt::destroy_hook::	829	bless \shift, urxvt::destroy_hook::
549	}	830	}
550		831
		832	package urxvt::anyevent;
		833
		834	=head2 The C<urxvt::anyevent> Class
		835
		836	The sole purpose of this class is to deliver an interface to the
		837	C<AnyEvent> module - any module using it will work inside urxvt without
		838	further programming. The only exception is that you cannot wait on
		839	condition variables, but non-blocking condvar use is ok. What this means
		840	is that you cannot use blocking APIs, but the non-blocking variant should
		841	work.
		842
		843	=cut
		844
		845	our $VERSION = 1;
		846
		847	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		848	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		849
		850	sub timer {
		851	my ($class, %arg) = @_;
		852
		853	my $cb = $arg{cb};
		854
		855	urxvt::timer
		856	->new
		857	->start (urxvt::NOW + $arg{after})
		858	->cb (sub {
		859	$_[0]->stop; # need to cancel manually
		860	$cb->();
		861	})
		862	}
		863
		864	sub io {
		865	my ($class, %arg) = @_;
		866
		867	my $cb = $arg{cb};
		868
		869	bless [$arg{fh}, urxvt::iow
		870	->new
		871	->fd (fileno $arg{fh})
		872	->events (($arg{poll} =~ /r/ ? 1 : 0)
		873	\| ($arg{poll} =~ /w/ ? 2 : 0))
		874	->start
		875	->cb (sub {
		876	$cb->(($_[1] & 1 ? 'r' : '')
		877	. ($_[1] & 2 ? 'w' : ''));
		878	})],
		879	urxvt::anyevent::
		880	}
		881
		882	sub DESTROY {
		883	$_[0][1]->stop;
		884	}
		885
		886	sub condvar {
		887	bless \my $flag, urxvt::anyevent::condvar::
		888	}
		889
		890	sub urxvt::anyevent::condvar::broadcast {
		891	${$_[0]}++;
		892	}
		893
		894	sub urxvt::anyevent::condvar::wait {
		895	unless (${$_[0]}) {
		896	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		897	}
		898	}
		899
		900	package urxvt::term;
		901
551	=head2 The C<urxvt::term> Class	902	=head2 The C<urxvt::term> Class
552		903
553	=over 4	904	=over 4
554		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
555	=item $term->destroy	947	=item $term->destroy
556		948
557	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.
		952
		953	=item $isset = $term->option ($optval[, $set])
		954
		955	Returns true if the option specified by C<$optval> is enabled, and
		956	optionally change it. All option values are stored by name in the hash
		957	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		958
		959	Here is a a likely non-exhaustive list of option names, please see the
		960	source file F</src/optinc.h> to see the actual list:
		961
		962	borderLess console cursorBlink cursorUnderline hold iconic insecure
		963	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		964	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		965	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		966	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		967	transparent tripleclickwords utmpInhibit visualBell
558		968
559	=item $value = $term->resource ($name[, $newval])	969	=item $value = $term->resource ($name[, $newval])
560		970
561	Returns the current resource value associated with a given name and	971	Returns the current resource value associated with a given name and
562	optionally sets a new value. Setting values is most useful in the C<init>	972	optionally sets a new value. Setting values is most useful in the C<init>
…		…
572		982
573	Please note that resource strings will currently only be freed when the	983	Please note that resource strings will currently only be freed when the
574	terminal is destroyed, so changing options frequently will eat memory.	984	terminal is destroyed, so changing options frequently will eat memory.
575		985
576	Here is a a likely non-exhaustive list of resource names, not all of which	986	Here is a a likely non-exhaustive list of resource names, not all of which
577	are supported in every build, please see the source to see the actual	987	are supported in every build, please see the source file F</src/rsinc.h>
578	list:	988	to see the actual list:
579		989
580	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	990	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
581	borderLess color cursorBlink cursorUnderline cutchars delete_key	991	borderLess color cursorBlink cursorUnderline cutchars delete_key
582	display_name embed ext_bwidth fade font geometry hold iconName	992	display_name embed ext_bwidth fade font geometry hold iconName
583	imFont imLocale inputMethod insecure int_bwidth intensityStyles	993	imFont imLocale inputMethod insecure int_bwidth intensityStyles
584	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	994	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
585	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	995	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
586	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	996	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
587	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	997	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
588	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	998	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
589	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	999	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
590	shade term_name title transparent transparent_all tripleclickwords	1000	secondaryScreen secondaryScroll selectstyle shade term_name title
591	utmpInhibit visualBell	1001	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1002	visualBell
592		1003
593	=cut	1004	=cut
594		1005
595	sub urxvt::term::resource($$;$) {	1006	sub resource($$;$) {
596	my ($self, $name) = (shift, shift);	1007	my ($self, $name) = (shift, shift);
597	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1008	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
598	&urxvt::term::_resource	1009	&urxvt::term::_resource
599	}	1010	}
600		1011
		1012	=item $value = $term->x_resource ($pattern)
		1013
		1014	Returns the X-Resource for the given pattern, excluding the program or
		1015	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1016	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1017	resource with that pattern exists.
		1018
		1019	This method should only be called during the C<on_start> hook, as there is
		1020	only one resource database per display, and later invocations might return
		1021	the wrong resources.
		1022
		1023	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1024
		1025	Adds a keymap translation exactly as specified via a resource. See the
		1026	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1027
601	=item $rend = $term->rstyle ([$new_rstyle])	1028	=item $rend = $term->rstyle ([$new_rstyle])
602		1029
603	Return and optionally change the current rendition. Text that is output by	1030	Return and optionally change the current rendition. Text that is output by
604	the terminal application will use this style.	1031	the terminal application will use this style.
605		1032
…		…
615	=item ($row, $col) = $term->selection_end ([$row, $col])	1042	=item ($row, $col) = $term->selection_end ([$row, $col])
616		1043
617	Return the current values of the selection mark, begin or end positions,	1044	Return the current values of the selection mark, begin or end positions,
618	and optionally set them to new values.	1045	and optionally set them to new values.
619		1046
		1047	=item $term->selection_make ($eventtime[, $rectangular])
		1048
		1049	Tries to make a selection as set by C<selection_beg> and
		1050	C<selection_end>. If C<$rectangular> is true (default: false), a
		1051	rectangular selection will be made. This is the prefered function to make
		1052	a selection.
		1053
620	=item $success = $term->selection_grab ($eventtime)	1054	=item $success = $term->selection_grab ($eventtime)
621		1055
622	Try to request the primary selection from the server (for example, as set	1056	Try to request the primary selection text from the server (for example, as
623	by the next method).	1057	set by the next method). No visual feedback will be given. This function
		1058	is mostly useful from within C<on_sel_grab> hooks.
624		1059
625	=item $oldtext = $term->selection ([$newtext])	1060	=item $oldtext = $term->selection ([$newtext])
626		1061
627	Return the current selection text and optionally replace it by C<$newtext>.	1062	Return the current selection text and optionally replace it by C<$newtext>.
628		1063
629	#=item $term->overlay ($x, $y, $text)	1064	=item $term->overlay_simple ($x, $y, $text)
630	#	1065
631	#Create a simple multi-line overlay box. See the next method for details.	1066	Create a simple multi-line overlay box. See the next method for details.
632	#	1067
633	#=cut	1068	=cut
634	#	1069
635	#sub urxvt::term::scr_overlay {	1070	sub overlay_simple {
636	# my ($self, $x, $y, $text) = @_;	1071	my ($self, $x, $y, $text) = @_;
637	#	1072
638	# my @lines = split /\n/, $text;	1073	my @lines = split /\n/, $text;
639	#	1074
640	# my $w = 0;	1075	my $w = List::Util::max map $self->strwidth ($_), @lines;
641	# for (map $self->strwidth ($_), @lines) {	1076
642	# $w = $_ if $w < $_;
643	# }
644	#
645	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1077	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
646	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1078	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
647	#}	1079
		1080	$overlay
		1081	}
648		1082
649	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1083	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
650		1084
651	Create a new (empty) overlay at the given position with the given	1085	Create a new (empty) overlay at the given position with the given
652	width/height. C<$rstyle> defines the initial rendition style	1086	width/height. C<$rstyle> defines the initial rendition style
…		…
687	C<$event> I<must> be the event causing the menu to pop up (a button event,	1121	C<$event> I<must> be the event causing the menu to pop up (a button event,
688	currently).	1122	currently).
689		1123
690	=cut	1124	=cut
691		1125
692	sub urxvt::term::popup {	1126	sub popup {
693	my ($self, $event) = @_;	1127	my ($self, $event) = @_;
694		1128
695	$self->grab ($event->{time}, 1)	1129	$self->grab ($event->{time}, 1)
696	or return;	1130	or return;
697		1131
…		…
719		1153
720	=item $string = $term->locale_decode ($octets)	1154	=item $string = $term->locale_decode ($octets)
721		1155
722	Convert the given locale-encoded octets into a perl string.	1156	Convert the given locale-encoded octets into a perl string.
723		1157
		1158	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1159
		1160	XORs the rendition values in the given span with the provided value
		1161	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1162	refresh hooks to provide effects similar to the selection.
		1163
		1164	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1165
		1166	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1167	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1168	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1169	it instead. Both styles I<MUST NOT> contain font styles.
		1170
		1171	=item $term->scr_bell
		1172
		1173	Ring the bell!
		1174
724	=item $term->scr_add_lines ($string)	1175	=item $term->scr_add_lines ($string)
725		1176
726	Write the given text string to the screen, as if output by the application	1177	Write the given text string to the screen, as if output by the application
727	running inside the terminal. It may not contain command sequences (escape	1178	running inside the terminal. It may not contain command sequences (escape
728	codes), but is free to use line feeds, carriage returns and tabs. The	1179	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
742		1193
743	Write the octets given in C<$data> to the tty (i.e. as program input). To	1194	Write the octets given in C<$data> to the tty (i.e. as program input). To
744	pass characters instead of octets, you should convert your strings first	1195	pass characters instead of octets, you should convert your strings first
745	to the locale-specific encoding using C<< $term->locale_encode >>.	1196	to the locale-specific encoding using C<< $term->locale_encode >>.
746		1197
		1198	=item $old_events = $term->pty_ev_events ([$new_events])
		1199
		1200	Replaces the event mask of the pty watcher by the given event mask. Can
		1201	be used to suppress input and output handling to the pty/tty. See the
		1202	description of C<< urxvt::timer->events >>. Make sure to always restore
		1203	the previous value.
		1204
747	=item $windowid = $term->parent	1205	=item $windowid = $term->parent
748		1206
749	Return the window id of the toplevel window.	1207	Return the window id of the toplevel window.
750		1208
751	=item $windowid = $term->vt	1209	=item $windowid = $term->vt
752		1210
753	Return the window id of the terminal window.	1211	Return the window id of the terminal window.
754		1212
		1213	=item $term->vt_emask_add ($x_event_mask)
		1214
		1215	Adds the specified events to the vt event mask. Useful e.g. when you want
		1216	to receive pointer events all the times:
		1217
		1218	$term->vt_emask_add (urxvt::PointerMotionMask);
		1219
755	=item $window_width = $term->width	1220	=item $window_width = $term->width
756		1221
757	=item $window_height = $term->height	1222	=item $window_height = $term->height
758		1223
759	=item $font_width = $term->fwidth	1224	=item $font_width = $term->fwidth
…		…
772		1237
773	=item $max_scrollback = $term->saveLines	1238	=item $max_scrollback = $term->saveLines
774		1239
775	=item $nrow_plus_saveLines = $term->total_rows	1240	=item $nrow_plus_saveLines = $term->total_rows
776		1241
777	=item $lines_in_scrollback = $term->nsaved	1242	=item $topmost_scrollback_row = $term->top_row
778		1243
779	Return various integers describing terminal characteristics.	1244	Return various integers describing terminal characteristics.
780		1245
		1246	=item $x_display = $term->display_id
		1247
		1248	Return the DISPLAY used by rxvt-unicode.
		1249
		1250	=item $lc_ctype = $term->locale
		1251
		1252	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1253
		1254	=item $env = $term->env
		1255
		1256	Returns a copy of the environment in effect for the terminal as a hashref
		1257	similar to C<\%ENV>.
		1258
		1259	=cut
		1260
		1261	sub env {
		1262	if (my $env = $_[0]->_env) {
		1263	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1264	} else {
		1265	+{ %ENV }
		1266	}
		1267	}
		1268
		1269	=item $modifiermask = $term->ModLevel3Mask
		1270
		1271	=item $modifiermask = $term->ModMetaMask
		1272
		1273	=item $modifiermask = $term->ModNumLockMask
		1274
		1275	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1276	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1277
781	=item $view_start = $term->view_start ([$newvalue])	1278	=item $view_start = $term->view_start ([$newvalue])
782		1279
783	Returns the negative row number of the topmost line. Minimum value is	1280	Returns the row number of the topmost displayed line. Maximum value is
784	C<0>, which displays the normal terminal contents. Larger values scroll	1281	C<0>, which displays the normal terminal contents. Lower values scroll
785	this many lines into the scrollback buffer.	1282	this many lines into the scrollback buffer.
786		1283
787	=item $term->want_refresh	1284	=item $term->want_refresh
788		1285
789	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1286	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
868	Return the row number of the first/last row of the line, respectively.	1365	Return the row number of the first/last row of the line, respectively.
869		1366
870	=item $offset = $line->offset_of ($row, $col)	1367	=item $offset = $line->offset_of ($row, $col)
871		1368
872	Returns the character offset of the given row\|col pair within the logical	1369	Returns the character offset of the given row\|col pair within the logical
873	line.	1370	line. Works for rows outside the line, too, and returns corresponding
		1371	offsets outside the string.
874		1372
875	=item ($row, $col) = $line->coord_of ($offset)	1373	=item ($row, $col) = $line->coord_of ($offset)
876		1374
877	Translates a string offset into terminal coordinates again.	1375	Translates a string offset into terminal coordinates again.
878		1376
879	=back	1377	=back
880		1378
881	=cut	1379	=cut
882		1380
883	sub urxvt::term::line {	1381	sub line {
884	my ($self, $row) = @_;	1382	my ($self, $row) = @_;
885		1383
886	my $maxrow = $self->nrow - 1;	1384	my $maxrow = $self->nrow - 1;
887		1385
888	my ($beg, $end) = ($row, $row);	1386	my ($beg, $end) = ($row, $row);
…		…
952	$offset / $self->{ncol} + $self->{beg},	1450	$offset / $self->{ncol} + $self->{beg},
953	$offset % $self->{ncol}	1451	$offset % $self->{ncol}
954	)	1452	)
955	}	1453	}
956		1454
957	=item ($row, $col) = $line->coord_of ($offset)
958	=item $text = $term->special_encode $string	1455	=item $text = $term->special_encode $string
959		1456
960	Converts a perl string into the special encoding used by rxvt-unicode,	1457	Converts a perl string into the special encoding used by rxvt-unicode,
961	where one character corresponds to one screen cell. See	1458	where one character corresponds to one screen cell. See
962	C<< $term->ROW_t >> for details.	1459	C<< $term->ROW_t >> for details.
…		…
964	=item $string = $term->special_decode $text	1461	=item $string = $term->special_decode $text
965		1462
966	Converts rxvt-unicodes text reprsentation into a perl string. See	1463	Converts rxvt-unicodes text reprsentation into a perl string. See
967	C<< $term->ROW_t >> for details.	1464	C<< $term->ROW_t >> for details.
968		1465
		1466	=item $success = $term->grab_button ($button, $modifiermask)
		1467
		1468	Registers a synchronous button grab. See the XGrabButton manpage.
		1469
		1470	=item $success = $term->grab ($eventtime[, $sync])
		1471
		1472	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1473	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1474
		1475	=item $term->allow_events_async
		1476
		1477	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1478
		1479	=item $term->allow_events_sync
		1480
		1481	Calls XAllowEvents with SyncBoth for the most recent grab.
		1482
		1483	=item $term->allow_events_replay
		1484
		1485	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1486	recent grab.
		1487
		1488	=item $term->ungrab
		1489
		1490	Calls XUngrab for the most recent grab. Is called automatically on
		1491	evaluation errors, as it is better to lose the grab in the error case as
		1492	the session.
		1493
969	=back	1494	=back
970		1495
		1496	=cut
		1497
		1498	package urxvt::popup;
		1499
971	=head2 The C<urxvt::popup> Class	1500	=head2 The C<urxvt::popup> Class
972		1501
973	=over 4	1502	=over 4
974		1503
975	=cut	1504	=cut
976
977	package urxvt::popup;
978		1505
979	sub add_item {	1506	sub add_item {
980	my ($self, $item) = @_;	1507	my ($self, $item) = @_;
981		1508
		1509	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1510	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1511	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1512
		1513	$item->{render} \|\|= sub { $_[0]{text} };
		1514
982	push @{ $self->{item} }, $item;	1515	push @{ $self->{item} }, $item;
983	}	1516	}
		1517
		1518	=item $popup->add_title ($title)
		1519
		1520	Adds a non-clickable title to the popup.
		1521
		1522	=cut
		1523
		1524	sub add_title {
		1525	my ($self, $title) = @_;
		1526
		1527	$self->add_item ({
		1528	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1529	text => $title,
		1530	activate => sub { },
		1531	});
		1532	}
		1533
		1534	=item $popup->add_separator ([$sepchr])
		1535
		1536	Creates a separator, optionally using the character given as C<$sepchr>.
		1537
		1538	=cut
		1539
		1540	sub add_separator {
		1541	my ($self, $sep) = @_;
		1542
		1543	$sep \|\|= "=";
		1544
		1545	$self->add_item ({
		1546	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1547	text => "",
		1548	render => sub { $sep x $self->{term}->ncol },
		1549	activate => sub { },
		1550	});
		1551	}
		1552
		1553	=item $popup->add_button ($text, $cb)
		1554
		1555	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1556	selected.
		1557
		1558	=cut
984		1559
985	sub add_button {	1560	sub add_button {
986	my ($self, $text, $cb) = @_;	1561	my ($self, $text, $cb) = @_;
987		1562
988	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb });	1563	$self->add_item ({ type => "button", text => $text, activate => $cb});
989	}	1564	}
		1565
		1566	=item $popup->add_toggle ($text, $cb, $initial_value)
		1567
		1568	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1569	whenever it gets toggled, with a boolean indicating its value as its first
		1570	argument.
		1571
		1572	=cut
		1573
		1574	sub add_toggle {
		1575	my ($self, $text, $cb, $value) = @_;
		1576
		1577	my $item; $item = {
		1578	type => "button",
		1579	text => " $text",
		1580	value => $value,
		1581	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1582	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1583	};
		1584
		1585	$self->add_item ($item);
		1586	}
		1587
		1588	=item $popup->show
		1589
		1590	Displays the popup (which is initially hidden).
		1591
		1592	=cut
990		1593
991	sub show {	1594	sub show {
992	my ($self) = @_;	1595	my ($self) = @_;
993		1596
994	local $urxvt::popup::self = $self;	1597	local $urxvt::popup::self = $self;
995		1598
996	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1599	my $env = $self->{term}->env;
		1600	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1601	delete $env->{LC_ALL};
		1602	$env->{LC_CTYPE} = $self->{term}->locale;
		1603
		1604	urxvt::term->new ($env, "popup",
		1605	"--perl-lib" => "", "--perl-ext-common" => "",
		1606	"-pty-fd" => -1, "-sl" => 0, "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
997	"--transient-for" => $self->{term}->parent,	1607	"--transient-for" => $self->{term}->parent,
		1608	"-display" => $self->{term}->display_id,
998	"-pe" => "urxvt_popup")	1609	"-pe" => "urxvt-popup")
999	or die "unable to create popup window\n";	1610	or die "unable to create popup window\n";
1000	}	1611	}
1001		1612
1002	sub DESTROY {	1613	sub DESTROY {
1003	my ($self) = @_;	1614	my ($self) = @_;
1004		1615
		1616	delete $self->{term}{_destroy}{$self};
1005	$self->{term}->ungrab;	1617	$self->{term}->ungrab;
1006	}	1618	}
		1619
		1620	=back
1007		1621
1008	=head2 The C<urxvt::timer> Class	1622	=head2 The C<urxvt::timer> Class
1009		1623
1010	This class implements timer watchers/events. Time is represented as a	1624	This class implements timer watchers/events. Time is represented as a
1011	fractional number of seconds since the epoch. Example:	1625	fractional number of seconds since the epoch. Example:
…		…
1050		1664
1051	=item $timer = $timer->start ($tstamp)	1665	=item $timer = $timer->start ($tstamp)
1052		1666
1053	Set the event trigger time to C<$tstamp> and start the timer.	1667	Set the event trigger time to C<$tstamp> and start the timer.
1054		1668
		1669	=item $timer = $timer->after ($delay)
		1670
		1671	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1672
1055	=item $timer = $timer->stop	1673	=item $timer = $timer->stop
1056		1674
1057	Stop the timer.	1675	Stop the timer.
1058		1676
1059	=back	1677	=back
…		…
1064		1682
1065	$term->{socket} = ...	1683	$term->{socket} = ...
1066	$term->{iow} = urxvt::iow	1684	$term->{iow} = urxvt::iow
1067	->new	1685	->new
1068	->fd (fileno $term->{socket})	1686	->fd (fileno $term->{socket})
1069	->events (1) # wait for read data	1687	->events (urxvt::EVENT_READ)
1070	->start	1688	->start
1071	->cb (sub {	1689	->cb (sub {
1072	my ($iow, $revents) = @_;	1690	my ($iow, $revents) = @_;
1073	# $revents must be 1 here, no need to check	1691	# $revents must be 1 here, no need to check
1074	sysread $term->{socket}, my $buf, 8192	1692	sysread $term->{socket}, my $buf, 8192
…		…
1091		1709
1092	Set the filedescriptor (not handle) to watch.	1710	Set the filedescriptor (not handle) to watch.
1093		1711
1094	=item $iow = $iow->events ($eventmask)	1712	=item $iow = $iow->events ($eventmask)
1095		1713
1096	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1714	Set the event mask to watch. The only allowed values are
1097	data, Bit #1 (value C<2>) enables watching for write data.	1715	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1716	together, or C<urxvt::EVENT_NONE>.
1098		1717
1099	=item $iow = $iow->start	1718	=item $iow = $iow->start
1100		1719
1101	Start watching for requested events on the given handle.	1720	Start watching for requested events on the given handle.
1102		1721
…		…
1113	This variable controls the verbosity level of the perl extension. Higher	1732	This variable controls the verbosity level of the perl extension. Higher
1114	numbers indicate more verbose output.	1733	numbers indicate more verbose output.
1115		1734
1116	=over 4	1735	=over 4
1117		1736
1118	=item =0 - only fatal messages	1737	=item == 0 - fatal messages
1119		1738
1120	=item =3 - script loading and management	1739	=item >= 3 - script loading and management
1121		1740
1122	=item =10 - all events received	1741	=item >=10 - all called hooks
		1742
		1743	=item >=11 - hook reutrn values
1123		1744
1124	=back	1745	=back
1125		1746
1126	=head1 AUTHOR	1747	=head1 AUTHOR
1127		1748

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.45 by root, Sat Jan 7 20:23:52 2006 UTC vs. Revision 1.105 by root, Wed Jan 18 19:43:51 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.45 by root, Sat Jan 7 20:23:52 2006 UTC vs.
Revision 1.105 by root, Wed Jan 18 19:43:51 2006 UTC