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

Diff Legend

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