ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.29 by root, Wed Jan 4 00:12:12 2006 UTC vs.
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC

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

Diff Legend

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