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

Diff Legend

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