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

Diff Legend

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