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.37 by root, Fri Jan 6 03:40:19 2006 UTC vs.
Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC

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

Diff Legend

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