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

Diff Legend

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