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.48 by root, Sat Jan 7 21:43:17 2006 UTC vs.
Revision 1.118 by root, Fri Jan 20 18:50:49 2006 UTC

…		…
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	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection	46	=item selection (enabled by default)
43		47
44	Intelligent selection. This extension tries to be more intelligent when	48	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	49	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	50	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
49	It also offers the following bindable event:	54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\|([^|]+)\\|
		71
		72	You can look at the source of the selection extension to see more
		73	interesting uses, such as parsing a line from beginning to end.
		74
		75	This extension also offers following bindable keyboard commands:
50		76
51	=over 4	77	=over 4
52		78
53	=item rot13	79	=item rot13
54		80
…		…
56		82
57	URxvt.keysym.C-M-r: perl:selection:rot13	83	URxvt.keysym.C-M-r: perl:selection:rot13
58		84
59	=back	85	=back
60		86
61	=item digital-clock	87	=item option-popup (enabled by default)
62		88
63	Displays a digital clock using the built-in overlay.	89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		90	runtime.
		91
		92	=item selection-popup (enabled by default)
		93
		94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		95	text into various other formats/action (such as uri unescaping, perl
		96	evaluation, web-browser starting etc.), depending on content.
		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
		116
		117	=item searchable-scrollback<hotkey> (enabled by default)
		118
		119	Adds regex search functionality to the scrollback buffer, triggered
		120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		121	input/output is suspended and a regex is displayed at the bottom of the
		122	screen.
		123
		124	Inputting characters appends them to the regex and continues incremental
		125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		127	bottom. C<Escape> leaves search mode and returns to the point where search
		128	was started, while C<Enter> or C<Return> stay at the current position and
		129	additionally stores the first match in the current line into the primary
		130	selection.
		131
		132	=item selection-autotransform
		133
		134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item tabbed
		168
		169	This transforms the terminal into a tabbar with additional terminals, that
		170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		172	button per tab.
		173
		174	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		175	B<Shift-Right> will switch to the tab left or right of the current one,
		176	while B<Shift-Down> creates a new tab.
64		177
65	=item mark-urls	178	=item mark-urls
66		179
67	Uses per-line display filtering (C<on_line_update>) to underline urls.	180	Uses per-line display filtering (C<on_line_update>) to underline urls and
		181	make them clickable. When middle-clicked, the program specified in the
		182	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		183	the URL as first argument.
		184
		185	=item automove-background
		186
		187	This is basically a one-line extension that dynamically changes the background pixmap offset
		188	to the window position, in effect creating the same effect as pseudo transparency with
		189	a custom pixmap. No scaling is supported in this mode. Exmaple:
		190
		191	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
68		192
69	=item block-graphics-to-ascii	193	=item block-graphics-to-ascii
70		194
71	A not very useful example of filtering all text output to the terminal,	195	A not very useful example of filtering all text output to the terminal,
72	by replacing all line-drawing characters (U+2500 .. U+259F) by a	196	by replacing all line-drawing characters (U+2500 .. U+259F) by a
73	similar-looking ascii character.	197	similar-looking ascii character.
74		198
		199	=item digital-clock
		200
		201	Displays a digital clock using the built-in overlay.
		202
75	=item example-refresh-hooks	203	=item example-refresh-hooks
76		204
77	Displays a very simple digital clock in the upper right corner of the	205	Displays a very simple digital clock in the upper right corner of the
78	window. Illustrates overwriting the refresh callbacks to create your own	206	window. Illustrates overwriting the refresh callbacks to create your own
79	overlays or changes.	207	overlays or changes.
80		208
		209	=item selection-pastebin
		210
		211	This is a little rarely useful extension that Uploads the selection as
		212	textfile to a remote site (or does other things). (The implementation is
		213	not currently secure for use in a multiuser environment as it writes to
		214	F</tmp> directly.).
		215
		216	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		217	i.e.
		218
		219	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		220
		221	Pressing this combination runs a command with C<%> replaced by the name of
		222	the textfile. This command can be set via a resource:
		223
		224	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		225
		226	And the default is likely not useful to anybody but the few people around
		227	here :)
		228
		229	The name of the textfile is the hex encoded md5 sum of the selection, so
		230	the same content should lead to the same filename.
		231
		232	After a successful upload the selection will be replaced by the text given
		233	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		234	for the filename):
		235
		236	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		237
81	=back	238	=back
		239
		240	=head1 API DOCUMENTATION
82		241
83	=head2 General API Considerations	242	=head2 General API Considerations
84		243
85	All objects (such as terminals, time watchers etc.) are typical	244	All objects (such as terminals, time watchers etc.) are typical
86	reference-to-hash objects. The hash can be used to store anything you	245	reference-to-hash objects. The hash can be used to store anything you
…		…
99	=over 4	258	=over 4
100		259
101	=item $text	260	=item $text
102		261
103	Rxvt-unicodes special way of encoding text, where one "unicode" character	262	Rxvt-unicodes special way of encoding text, where one "unicode" character
104	always represents one screen cell. See L<row_t> for a discussion of this format.	263	always represents one screen cell. See L<ROW_t> for a discussion of this format.
105		264
106	=item $string	265	=item $string
107		266
108	A perl text string, with an emphasis on I<text>. It can store all unicode	267	A perl text string, with an emphasis on I<text>. It can store all unicode
109	characters and is to be distinguished with text encoded in a specific	268	characters and is to be distinguished with text encoded in a specific
…		…
114	Either binary data or - more common - a text string encoded in a	273	Either binary data or - more common - a text string encoded in a
115	locale-specific way.	274	locale-specific way.
116		275
117	=back	276	=back
118		277
		278	=head2 Extension Objects
		279
		280	Very perl extension is a perl class. A separate perl object is created
		281	for each terminal and each extension and passed as the first parameter to
		282	hooks. So extensions can use their C<$self> object without having to think
		283	about other extensions, with the exception of methods and members that
		284	begin with an underscore character C<_>: these are reserved for internal
		285	use.
		286
		287	Although it isn't a C<urxvt::term> object, you can call all methods of the
		288	C<urxvt::term> class on this object.
		289
		290	It has the following methods and data members:
		291
		292	=over 4
		293
		294	=item $urxvt_term = $self->{term}
		295
		296	Returns the C<urxvt::term> object associated with this instance of the
		297	extension. This member I<must not> be changed in any way.
		298
		299	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		300
		301	Dynamically enable the given hooks (named without the C<on_> prefix) for
		302	this extension, replacing any previous hook. This is useful when you want
		303	to overwrite time-critical hooks only temporarily.
		304
		305	=item $self->disable ($hook_name[, $hook_name..])
		306
		307	Dynamically disable the given hooks.
		308
		309	=back
		310
119	=head2 Hooks	311	=head2 Hooks
120		312
121	The following subroutines can be declared in extension files, and will be	313	The following subroutines can be declared in extension files, and will be
122	called whenever the relevant event happens.	314	called whenever the relevant event happens.
123		315
124	The first argument passed to them is an object private to each terminal	316	The first argument passed to them is an extension oject as described in
125	and extension package. You can call all C<urxvt::term> methods on it, but	317	the in the C<Extension Objects> section.
126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127	object that is shared between all packages is stored in the C<term>
128	member. It is, however, blessed intot he package of the extension script,
129	so for all practical purposes you can treat an extension script as a class.
130		318
131	All of them must return a boolean value. If it is true, then the event	319	B<All> of these hooks must return a boolean value. If any of the called
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	320	hooks returns true, then the event counts as being I<consumed>, and the
133	and the relevant action might not be carried out by the C++ code.	321	relevant action might not be carried out by the C++ code.
134		322
135	When in doubt, return a false value (preferably C<()>).	323	I<< When in doubt, return a false value (preferably C<()>). >>
136		324
137	=over 4	325	=over 4
138		326
139	=item on_init $term	327	=item on_init $term
140		328
141	Called after a new terminal object has been initialized, but before	329	Called after a new terminal object has been initialized, but before
142	windows are created or the command gets run. Most methods are unsafe to	330	windows are created or the command gets run. Most methods are unsafe to
143	call or deliver senseless data, as terminal size and other characteristics	331	call or deliver senseless data, as terminal size and other characteristics
144	have not yet been determined. You can safely query and change resources,	332	have not yet been determined. You can safely query and change resources
145	though.	333	and options, though. For many purposes the C<on_start> hook is a better
		334	place.
		335
		336	=item on_start $term
		337
		338	Called at the very end of initialisation of a new terminal, just before
		339	trying to map (display) the toplevel and returning to the mainloop.
		340
		341	=item on_destroy $term
		342
		343	Called whenever something tries to destroy terminal, before doing anything
		344	yet. If this hook returns true, then destruction is skipped, but this is
		345	rarely a good idea.
146		346
147	=item on_reset $term	347	=item on_reset $term
148		348
149	Called after the screen is "reset" for any reason, such as resizing or	349	Called after the screen is "reset" for any reason, such as resizing or
150	control sequences. Here is where you can react on changes to size-related	350	control sequences. Here is where you can react on changes to size-related
151	variables.	351	variables.
152		352
153	=item on_start $term	353	=item on_child_start $term, $pid
154		354
155	Called at the very end of initialisation of a new terminal, just before	355	Called just after the child process has been C<fork>ed.
156	returning to the mainloop.	356
		357	=item on_child_exit $term, $status
		358
		359	Called just after the child process has exited. C<$status> is the status
		360	from C<waitpid>.
157		361
158	=item on_sel_make $term, $eventtime	362	=item on_sel_make $term, $eventtime
159		363
160	Called whenever a selection has been made by the user, but before the	364	Called whenever a selection has been made by the user, but before the
161	selection text is copied, so changes to the beginning, end or type of the	365	selection text is copied, so changes to the beginning, end or type of the
…		…
175	=item on_sel_extend $term	379	=item on_sel_extend $term
176		380
177	Called whenever the user tries to extend the selection (e.g. with a double	381	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	382	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	383	should extend the selection itelf and return true to suppress the built-in
180	processing.	384	processing. This can happen multiple times, as long as the callback
		385	returns true, it will be called on every further click by the user and is
		386	supposed to enlarge the selection more and more, if possible.
181		387
182	See the F<selection> example extension.	388	See the F<selection> example extension.
183		389
184	=item on_view_change $term, $offset	390	=item on_view_change $term, $offset
185		391
…		…
194	than the scroll back buffer or the terminal.	400	than the scroll back buffer or the terminal.
195		401
196	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	402	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
197	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	403	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
198	number of lines that will be in the scrollback buffer.	404	number of lines that will be in the scrollback buffer.
199
200	=item on_tty_activity $term *NYI*
201
202	Called whenever the program(s) running in the urxvt window send output.
203		405
204	=item on_osc_seq $term, $string	406	=item on_osc_seq $term, $string
205		407
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	408	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	409	operating system command) is processed. Cursor position and other state
…		…
220	can filter/change and output the text yourself by returning a true value	422	can filter/change and output the text yourself by returning a true value
221	and calling C<< $term->scr_add_lines >> yourself. Please note that this	423	and calling C<< $term->scr_add_lines >> yourself. Please note that this
222	might be very slow, however, as your hook is called for B<all> text being	424	might be very slow, however, as your hook is called for B<all> text being
223	output.	425	output.
224		426
		427	=item on_tt_write $term, $octets
		428
		429	Called whenever some data is written to the tty/pty and can be used to
		430	suppress or filter tty input.
		431
225	=item on_line_update $term, $row	432	=item on_line_update $term, $row
226		433
227	Called whenever a line was updated or changed. Can be used to filter	434	Called whenever a line was updated or changed. Can be used to filter
228	screen output (e.g. underline urls or other useless stuff). Only lines	435	screen output (e.g. underline urls or other useless stuff). Only lines
229	that are being shown will be filtered, and, due to performance reasons,	436	that are being shown will be filtered, and, due to performance reasons,
…		…
251		458
252	Called whenever the user presses a key combination that has a	459	Called whenever the user presses a key combination that has a
253	C<perl:string> action bound to it (see description of the B<keysym>	460	C<perl:string> action bound to it (see description of the B<keysym>
254	resource in the @@RXVT_NAME@@(1) manpage).	461	resource in the @@RXVT_NAME@@(1) manpage).
255		462
		463	=item on_x_event $term, $event
		464
		465	Called on every X event received on the vt window (and possibly other
		466	windows). Should only be used as a last resort. Most event structure
		467	members are not passed.
		468
256	=item on_focus_in $term	469	=item on_focus_in $term
257		470
258	Called whenever the window gets the keyboard focus, before rxvt-unicode	471	Called whenever the window gets the keyboard focus, before rxvt-unicode
259	does focus in processing.	472	does focus in processing.
260		473
261	=item on_focus_out $term	474	=item on_focus_out $term
262		475
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	476	Called wheneever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	477	focus out processing.
265		478
		479	=item on_configure_notify $term, $event
		480
		481	=item on_property_notify $term, $event
		482
266	=item on_key_press $term, $event, $octets	483	=item on_key_press $term, $event, $keysym, $octets
267		484
268	=item on_key_release $term, $event	485	=item on_key_release $term, $event, $keysym
269		486
270	=item on_button_press $term, $event	487	=item on_button_press $term, $event
271		488
272	=item on_button_release $term, $event	489	=item on_button_release $term, $event
273		490
…		…
287	C<on_key_press> additionally receives the string rxvt-unicode would	504	C<on_key_press> additionally receives the string rxvt-unicode would
288	output, if any, in locale-specific encoding.	505	output, if any, in locale-specific encoding.
289		506
290	subwindow.	507	subwindow.
291		508
		509	=item on_client_message $term, $event
		510
		511	=item on_wm_protocols $term, $event
		512
		513	=item on_wm_delete_window $term, $event
		514
		515	Called when various types of ClientMessage events are received (all with
		516	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		517
292	=back	518	=back
293		519
		520	=cut
		521
		522	package urxvt;
		523
		524	use utf8;
		525	use strict;
		526	use Carp ();
		527	use Scalar::Util ();
		528	use List::Util ();
		529
		530	our $VERSION = 1;
		531	our $TERM;
		532	our @TERM_INIT;
		533	our @TERM_EXT;
		534	our @HOOKNAME;
		535	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		536	our %OPTION;
		537
		538	our $LIBDIR;
		539	our $RESNAME;
		540	our $RESCLASS;
		541	our $RXVTNAME;
		542
294	=head2 Variables in the C<urxvt> Package	543	=head2 Variables in the C<urxvt> Package
295		544
296	=over 4	545	=over 4
		546
		547	=item $urxvt::LIBDIR
		548
		549	The rxvt-unicode library directory, where, among other things, the perl
		550	modules and scripts are stored.
		551
		552	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		553
		554	The resource class and name rxvt-unicode uses to look up X resources.
		555
		556	=item $urxvt::RXVTNAME
		557
		558	The basename of the installed binaries, usually C<urxvt>.
297		559
298	=item $urxvt::TERM	560	=item $urxvt::TERM
299		561
300	The current terminal. This variable stores the current C<urxvt::term>	562	The current terminal. This variable stores the current C<urxvt::term>
301	object, whenever a callback/hook is executing.	563	object, whenever a callback/hook is executing.
302		564
		565	=item @urxvt::TERM_INIT
		566
		567	All coderefs in this array will be called as methods of the next newly
		568	created C<urxvt::term> object (during the C<on_init> phase). The array
		569	gets cleared before the codereferences that were in it are being executed,
		570	so coderefs can push themselves onto it again if they so desire.
		571
		572	This complements to the perl-eval commandline option, but gets executed
		573	first.
		574
		575	=item @urxvt::TERM_EXT
		576
		577	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		578	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		579	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		580
303	=back	581	=back
304		582
305	=head2 Functions in the C<urxvt> Package	583	=head2 Functions in the C<urxvt> Package
306		584
307	=over 4	585	=over 4
308
309	=item $term = new urxvt [arg...]
310
311	Creates a new terminal, very similar as if you had started it with
312	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
313	if the new instance couldn't be created. Returns C<undef> if the new
314	instance didn't initialise perl, and the terminal object otherwise. The
315	C<init> and C<start> hooks will be called during the call.
316		586
317	=item urxvt::fatal $errormessage	587	=item urxvt::fatal $errormessage
318		588
319	Fatally aborts execution with the given error message. Avoid at all	589	Fatally aborts execution with the given error message. Avoid at all
320	costs! The only time this is acceptable is when the terminal process	590	costs! The only time this is acceptable is when the terminal process
…		…
327	that calls this function.	597	that calls this function.
328		598
329	Using this function has the advantage that its output ends up in the	599	Using this function has the advantage that its output ends up in the
330	correct place, e.g. on stderr of the connecting urxvtc client.	600	correct place, e.g. on stderr of the connecting urxvtc client.
331		601
		602	Messages have a size limit of 1023 bytes currently.
		603
332	=item $time = urxvt::NOW	604	=item $time = urxvt::NOW
333		605
334	Returns the "current time" (as per the event loop).	606	Returns the "current time" (as per the event loop).
335		607
336	=item urxvt::CurrentTime	608	=item urxvt::CurrentTime
337		609
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	610	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	611	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	612	Button4Mask, Button5Mask, AnyModifier
341		613
		614	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		615	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		616	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		617	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		618	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		619	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		620	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		621
		622	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		623	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		624	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		625	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		626	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		627	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		628	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		629
342	Various constants for use in X events.	630	Various constants for use in X calls and event processing.
343		631
344	=back	632	=back
345		633
346	=head2 RENDITION	634	=head2 RENDITION
347		635
…		…
374		662
375	=item $background = urxvt::GET_BASEBG $rend	663	=item $background = urxvt::GET_BASEBG $rend
376		664
377	Return the foreground/background colour index, respectively.	665	Return the foreground/background colour index, respectively.
378		666
379	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	667	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
380		668
381	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	669	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
382		670
383	Replace the foreground/background colour in the rendition mask with the	671	Replace the foreground/background colour in the rendition mask with the
384	specified one.	672	specified one.
385		673
386	=item $value = urxvt::GET_CUSTOM ($rend)	674	=item $value = urxvt::GET_CUSTOM $rend
387		675
388	Return the "custom" value: Every rendition has 5 bits for use by	676	Return the "custom" value: Every rendition has 5 bits for use by
389	extensions. They can be set and changed as you like and are initially	677	extensions. They can be set and changed as you like and are initially
390	zero.	678	zero.
391		679
392	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	680	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
393		681
394	Change the custom value.	682	Change the custom value.
395		683
396	=back	684	=back
397		685
398	=cut	686	=cut
399		687
400	package urxvt;
401
402	use utf8;
403	use strict;
404	use Scalar::Util ();
405	use List::Util ();
406
407	our $TERM;
408	our @HOOKNAME;
409	our $LIBDIR;
410
411	BEGIN {	688	BEGIN {
412	urxvt->bootstrap;
413
414	# overwrite perl's warn	689	# overwrite perl's warn
415	*CORE::GLOBAL::warn = sub {	690	*CORE::GLOBAL::warn = sub {
416	my $msg = join "", @_;	691	my $msg = join "", @_;
417	$msg .= "\n"	692	$msg .= "\n"
418	unless $msg =~ /\n$/;	693	unless $msg =~ /\n$/;
419	urxvt::warn ($msg);	694	urxvt::warn ($msg);
420	};	695	};
421	}	696	}
422		697
423	my @hook_count;
424	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	698	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
425		699
426	sub verbose {	700	sub verbose {
427	my ($level, $msg) = @_;	701	my ($level, $msg) = @_;
428	warn "$msg\n" if $level <= $verbosity;	702	warn "$msg\n" if $level <= $verbosity;
429	}	703	}
430		704
431	# find on_xxx subs in the package and register them
432	# as hooks
433	sub register_package($) {
434	my ($pkg) = @_;
435
436	for my $htype (0.. $#HOOKNAME) {
437	my $name = $HOOKNAME[$htype];
438
439	my $ref = $pkg->can ("on_" . lc $name)
440	or next;
441
442	$TERM->{_hook}[$htype]{$pkg} = $ref;
443	$hook_count[$htype]++
444	or set_should_invoke $htype, 1;
445	}
446	}
447
448	my $extension_pkg = "extension0000";
449	my %extension_pkg;	705	my %extension_pkg;
450		706
451	# load a single script into its own package, once only	707	# load a single script into its own package, once only
452	sub extension_package($) {	708	sub extension_package($) {
453	my ($path) = @_;	709	my ($path) = @_;
454		710
455	$extension_pkg{$path} ||= do {	711	$extension_pkg{$path} ||= do {
456	my $pkg = "urxvt::" . ($extension_pkg++);	712	$path =~ /([^\/\\]+)$/;
		713	my $pkg = $1;
		714	$pkg =~ s/[^[:word:]]/_/g;
		715	$pkg = "urxvt::ext::$pkg";
457		716
458	verbose 3, "loading extension '$path' into package '$pkg'";	717	verbose 3, "loading extension '$path' into package '$pkg'";
459		718
460	open my $fh, "<:raw", $path	719	open my $fh, "<:raw", $path
461	or die "$path: $!";	720	or die "$path: $!";
462		721
		722	my $source =
463	my $source = "package $pkg; use strict; use utf8;\n"	723	"package $pkg; use strict; use utf8;\n"
464	. "use base urxvt::term::proxy::;\n"
465	. "#line 1 \"$path\"\n{\n"	724	. "#line 1 \"$path\"\n{\n"
466	. (do { local $/; <$fh> })	725	. (do { local $/; <$fh> })
467	. "\n};\n1";	726	. "\n};\n1";
468		727
		728	eval $source
469	eval $source or die "$path: $@";	729	or die "$path: $@";
470		730
471	$pkg	731	$pkg
472	}	732	}
473	}	733	}
474		734
…		…
479	local $TERM = shift;	739	local $TERM = shift;
480	my $htype = shift;	740	my $htype = shift;
481		741
482	if ($htype == 0) { # INIT	742	if ($htype == 0) { # INIT
483	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	743	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		744
		745	my %ext_arg;
484		746
		747	{
		748	my @init = @TERM_INIT;
		749	@TERM_INIT = ();
		750	$_->($TERM) for @init;
		751	my @pkg = @TERM_EXT;
		752	@TERM_EXT = ();
		753	$TERM->register_package ($_) for @pkg;
		754	}
		755
485	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	756	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		757	if ($_ eq "default") {
		758	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
		759	} elsif (/^-(.*)$/) {
		760	delete $ext_arg{$1};
		761	} elsif (/^([^<]+)<(.*)>$/) {
		762	push @{ $ext_arg{$1} }, $2;
		763	} else {
		764	$ext_arg{$_} ||= [];
		765	}
		766	}
		767
		768	while (my ($ext, $argv) = each %ext_arg) {
486	my @files = grep -f $_, map "$_/$ext", @dirs;	769	my @files = grep -f $_, map "$_/$ext", @dirs;
487		770
488	if (@files) {	771	if (@files) {
489	register_package extension_package $files[0];	772	$TERM->register_package (extension_package $files[0], $argv);
490	} else {	773	} else {
491	warn "perl extension '$ext' not found in perl library search path\n";	774	warn "perl extension '$ext' not found in perl library search path\n";
492	}	775	}
493	}	776	}
		777
		778	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		779	warn $@ if $@;
494	}	780	}
495		781
496	$retval = undef;	782	$retval = undef;
497		783
498	if (my $cb = $TERM->{_hook}[$htype]) {	784	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
500	if $verbosity >= 10;	786	if $verbosity >= 10;
501		787
502	keys %$cb;	788	keys %$cb;
503		789
504	while (my ($pkg, $cb) = each %$cb) {	790	while (my ($pkg, $cb) = each %$cb) {
505	eval {	791	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
506	$retval = $cb->(	792	$retval ||= $retval_;
507	$TERM->{_pkg}{$pkg} ||= do {
508	my $proxy = bless { }, $pkg;
509	Scalar::Util::weaken ($proxy->{term} = $TERM);
510	$proxy
511	},
512	@_,
513	) and last;
514	};
515	warn $@ if $@;#d#
516	}
517	}
518		793
519	if ($htype == 1) { # DESTROY	794	if ($@) {
520	# remove hooks if unused	795	$TERM->ungrab; # better to lose the grab than the session
521	if (my $hook = $TERM->{_hook}) {	796	warn $@;
522	for my $htype (0..$#$hook) {
523	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
524	or set_should_invoke $htype, 0;
525	}	797	}
526	}	798	}
527		799
		800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		801	if $verbosity >= 11;
		802	}
		803
		804	if ($htype == 1) { # DESTROY
528	# clear package objects	805	# clear package objects
529	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
530		807
531	# clear package	808	# clear package
532	%$TERM = ();	809	%$TERM = ();
533	}	810	}
534		811
535	$retval	812	$retval
536	}	813	}
537		814
538	sub urxvt::term::proxy::AUTOLOAD {	815	# urxvt::term::extension
539	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	816
		817	package urxvt::term::extension;
		818
		819	sub enable {
		820	my ($self, %hook) = @_;
		821	my $pkg = $self->{_pkg};
		822
		823	while (my ($name, $cb) = each %hook) {
		824	my $htype = $HOOKTYPE{uc $name};
		825	defined $htype
		826	or Carp::croak "unsupported hook type '$name'";
		827
		828	$self->set_should_invoke ($htype, +1)
		829	unless exists $self->{term}{_hook}[$htype]{$pkg};
		830
		831	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		832	}
		833	}
		834
		835	sub disable {
		836	my ($self, @hook) = @_;
		837	my $pkg = $self->{_pkg};
		838
		839	for my $name (@hook) {
		840	my $htype = $HOOKTYPE{uc $name};
		841	defined $htype
		842	or Carp::croak "unsupported hook type '$name'";
		843
		844	$self->set_should_invoke ($htype, -1)
		845	if delete $self->{term}{_hook}[$htype]{$pkg};
		846	}
		847	}
		848
		849	our $AUTOLOAD;
		850
		851	sub AUTOLOAD {
		852	$AUTOLOAD =~ /:([^:]+)$/
540	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	853	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
541		854
542	eval qq{	855	eval qq{
543	sub $urxvt::term::proxy::AUTOLOAD {	856	sub $AUTOLOAD {
544	my \$proxy = shift;	857	my \$proxy = shift;
545	\$proxy->{term}->$1 (\@_)	858	\$proxy->{term}->$1 (\@_)
546	}	859	}
547	1	860	1
548	} or die "FATAL: unable to compile method forwarder: $@";	861	} or die "FATAL: unable to compile method forwarder: $@";
549		862
550	goto &$urxvt::term::proxy::AUTOLOAD;	863	goto &$AUTOLOAD;
551	}	864	}
		865
		866	sub DESTROY {
		867	# nop
		868	}
		869
		870	# urxvt::destroy_hook
552		871
553	sub urxvt::destroy_hook::DESTROY {	872	sub urxvt::destroy_hook::DESTROY {
554	${$_[0]}->();	873	${$_[0]}->();
555	}	874	}
556		875
557	sub urxvt::destroy_hook(&) {	876	sub urxvt::destroy_hook(&) {
558	bless \shift, urxvt::destroy_hook::	877	bless \shift, urxvt::destroy_hook::
559	}	878	}
560		879
		880	package urxvt::anyevent;
		881
		882	=head2 The C<urxvt::anyevent> Class
		883
		884	The sole purpose of this class is to deliver an interface to the
		885	C<AnyEvent> module - any module using it will work inside urxvt without
		886	further programming. The only exception is that you cannot wait on
		887	condition variables, but non-blocking condvar use is ok. What this means
		888	is that you cannot use blocking APIs, but the non-blocking variant should
		889	work.
		890
		891	=cut
		892
		893	our $VERSION = 1;
		894
		895	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		896	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		897
		898	sub timer {
		899	my ($class, %arg) = @_;
		900
		901	my $cb = $arg{cb};
		902
		903	urxvt::timer
		904	->new
		905	->start (urxvt::NOW + $arg{after})
		906	->cb (sub {
		907	$_[0]->stop; # need to cancel manually
		908	$cb->();
		909	})
		910	}
		911
		912	sub io {
		913	my ($class, %arg) = @_;
		914
		915	my $cb = $arg{cb};
		916
		917	bless [$arg{fh}, urxvt::iow
		918	->new
		919	->fd (fileno $arg{fh})
		920	->events (($arg{poll} =~ /r/ ? 1 : 0)
		921	| ($arg{poll} =~ /w/ ? 2 : 0))
		922	->start
		923	->cb (sub {
		924	$cb->(($_[1] & 1 ? 'r' : '')
		925	. ($_[1] & 2 ? 'w' : ''));
		926	})],
		927	urxvt::anyevent::
		928	}
		929
		930	sub DESTROY {
		931	$_[0][1]->stop;
		932	}
		933
		934	sub condvar {
		935	bless \my $flag, urxvt::anyevent::condvar::
		936	}
		937
		938	sub urxvt::anyevent::condvar::broadcast {
		939	${$_[0]}++;
		940	}
		941
		942	sub urxvt::anyevent::condvar::wait {
		943	unless (${$_[0]}) {
		944	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		945	}
		946	}
		947
		948	package urxvt::term;
		949
561	=head2 The C<urxvt::term> Class	950	=head2 The C<urxvt::term> Class
562		951
563	=over 4	952	=over 4
564		953
		954	=cut
		955
		956	# find on_xxx subs in the package and register them
		957	# as hooks
		958	sub register_package {
		959	my ($self, $pkg, $argv) = @_;
		960
		961	no strict 'refs';
		962
		963	urxvt::verbose 6, "register package $pkg to $self";
		964
		965	@{"$pkg\::ISA"} = urxvt::term::extension::;
		966
		967	my $proxy = bless {
		968	_pkg => $pkg,
		969	argv => $argv,
		970	}, $pkg;
		971	Scalar::Util::weaken ($proxy->{term} = $self);
		972
		973	$self->{_pkg}{$pkg} = $proxy;
		974
		975	for my $name (@HOOKNAME) {
		976	if (my $ref = $pkg->can ("on_" . lc $name)) {
		977	$proxy->enable ($name => $ref);
		978	}
		979	}
		980	}
		981
		982	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		983
		984	Creates a new terminal, very similar as if you had started it with system
		985	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		986	hash which defines the environment of the new terminal.
		987
		988	Croaks (and probably outputs an error message) if the new instance
		989	couldn't be created. Returns C<undef> if the new instance didn't
		990	initialise perl, and the terminal object otherwise. The C<init> and
		991	C<start> hooks will be called during this call.
		992
		993	=cut
		994
		995	sub new {
		996	my ($class, $env, @args) = @_;
		997
		998	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		999	}
		1000
565	=item $term->destroy	1001	=item $term->destroy
566		1002
567	Destroy the terminal object (close the window, free resources etc.).	1003	Destroy the terminal object (close the window, free resources
		1004	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1005	watchers (timers, io watchers) are still active.
		1006
		1007	=item $term->exec_async ($cmd[, @args])
		1008
		1009	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1010	("starts") programs in the background. This function takes care of setting
		1011	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1012	be preferred over explicit calls to C<exec> or C<system>.
		1013
		1014	Returns the pid of the subprocess or C<undef> on error.
		1015
		1016	=cut
		1017
		1018	sub exec_async {
		1019	my $self = shift;
		1020
		1021	my $pid = fork;
		1022
		1023	return $pid
		1024	if !defined $pid or $pid;
		1025
		1026	%ENV = %{ $self->env };
		1027
		1028	exec @_;
		1029	urxvt::_exit 255;
		1030	}
		1031
		1032	=item $isset = $term->option ($optval[, $set])
		1033
		1034	Returns true if the option specified by C<$optval> is enabled, and
		1035	optionally change it. All option values are stored by name in the hash
		1036	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1037
		1038	Here is a a likely non-exhaustive list of option names, please see the
		1039	source file F</src/optinc.h> to see the actual list:
		1040
		1041	borderLess console cursorBlink cursorUnderline hold iconic insecure
		1042	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		1043	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		1044	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		1045	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		1046	transparent tripleclickwords utmpInhibit visualBell
568		1047
569	=item $value = $term->resource ($name[, $newval])	1048	=item $value = $term->resource ($name[, $newval])
570		1049
571	Returns the current resource value associated with a given name and	1050	Returns the current resource value associated with a given name and
572	optionally sets a new value. Setting values is most useful in the C<init>	1051	optionally sets a new value. Setting values is most useful in the C<init>
…		…
582		1061
583	Please note that resource strings will currently only be freed when the	1062	Please note that resource strings will currently only be freed when the
584	terminal is destroyed, so changing options frequently will eat memory.	1063	terminal is destroyed, so changing options frequently will eat memory.
585		1064
586	Here is a a likely non-exhaustive list of resource names, not all of which	1065	Here is a a likely non-exhaustive list of resource names, not all of which
587	are supported in every build, please see the source to see the actual	1066	are supported in every build, please see the source file F</src/rsinc.h>
588	list:	1067	to see the actual list:
589		1068
590	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1069	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
591	borderLess color cursorBlink cursorUnderline cutchars delete_key	1070	borderLess color cursorBlink cursorUnderline cutchars delete_key
592	display_name embed ext_bwidth fade font geometry hold iconName	1071	display_name embed ext_bwidth fade font geometry hold iconName
593	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1072	imFont imLocale inputMethod insecure int_bwidth intensityStyles
594	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1073	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
595	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1074	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
596	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1075	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
597	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1076	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
598	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1077	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
599	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1078	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
600	shade term_name title transparent transparent_all tripleclickwords	1079	secondaryScreen secondaryScroll selectstyle shade term_name title
601	utmpInhibit visualBell	1080	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1081	visualBell
602		1082
603	=cut	1083	=cut
604		1084
605	sub urxvt::term::resource($$;$) {	1085	sub resource($$;$) {
606	my ($self, $name) = (shift, shift);	1086	my ($self, $name) = (shift, shift);
607	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1087	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
608	&urxvt::term::_resource	1088	&urxvt::term::_resource
609	}	1089	}
610		1090
		1091	=item $value = $term->x_resource ($pattern)
		1092
		1093	Returns the X-Resource for the given pattern, excluding the program or
		1094	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1095	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1096	resource with that pattern exists.
		1097
		1098	This method should only be called during the C<on_start> hook, as there is
		1099	only one resource database per display, and later invocations might return
		1100	the wrong resources.
		1101
		1102	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1103
		1104	Adds a keymap translation exactly as specified via a resource. See the
		1105	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1106
611	=item $rend = $term->rstyle ([$new_rstyle])	1107	=item $rend = $term->rstyle ([$new_rstyle])
612		1108
613	Return and optionally change the current rendition. Text that is output by	1109	Return and optionally change the current rendition. Text that is output by
614	the terminal application will use this style.	1110	the terminal application will use this style.
615		1111
…		…
625	=item ($row, $col) = $term->selection_end ([$row, $col])	1121	=item ($row, $col) = $term->selection_end ([$row, $col])
626		1122
627	Return the current values of the selection mark, begin or end positions,	1123	Return the current values of the selection mark, begin or end positions,
628	and optionally set them to new values.	1124	and optionally set them to new values.
629		1125
		1126	=item $term->selection_make ($eventtime[, $rectangular])
		1127
		1128	Tries to make a selection as set by C<selection_beg> and
		1129	C<selection_end>. If C<$rectangular> is true (default: false), a
		1130	rectangular selection will be made. This is the prefered function to make
		1131	a selection.
		1132
630	=item $success = $term->selection_grab ($eventtime)	1133	=item $success = $term->selection_grab ($eventtime)
631		1134
632	Try to request the primary selection from the server (for example, as set	1135	Try to request the primary selection text from the server (for example, as
633	by the next method).	1136	set by the next method). No visual feedback will be given. This function
		1137	is mostly useful from within C<on_sel_grab> hooks.
634		1138
635	=item $oldtext = $term->selection ([$newtext])	1139	=item $oldtext = $term->selection ([$newtext])
636		1140
637	Return the current selection text and optionally replace it by C<$newtext>.	1141	Return the current selection text and optionally replace it by C<$newtext>.
638		1142
639	#=item $term->overlay ($x, $y, $text)	1143	=item $term->overlay_simple ($x, $y, $text)
640	#	1144
641	#Create a simple multi-line overlay box. See the next method for details.	1145	Create a simple multi-line overlay box. See the next method for details.
642	#	1146
643	#=cut	1147	=cut
644	#	1148
645	#sub urxvt::term::scr_overlay {	1149	sub overlay_simple {
646	# my ($self, $x, $y, $text) = @_;	1150	my ($self, $x, $y, $text) = @_;
647	#	1151
648	# my @lines = split /\n/, $text;	1152	my @lines = split /\n/, $text;
649	#	1153
650	# my $w = 0;	1154	my $w = List::Util::max map $self->strwidth ($_), @lines;
651	# for (map $self->strwidth ($_), @lines) {	1155
652	# $w = $_ if $w < $_;
653	# }
654	#
655	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1156	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
656	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1157	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
657	#}	1158
		1159	$overlay
		1160	}
658		1161
659	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1162	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
660		1163
661	Create a new (empty) overlay at the given position with the given	1164	Create a new (empty) overlay at the given position with the given
662	width/height. C<$rstyle> defines the initial rendition style	1165	width/height. C<$rstyle> defines the initial rendition style
…		…
697	C<$event> I<must> be the event causing the menu to pop up (a button event,	1200	C<$event> I<must> be the event causing the menu to pop up (a button event,
698	currently).	1201	currently).
699		1202
700	=cut	1203	=cut
701		1204
702	sub urxvt::term::popup {	1205	sub popup {
703	my ($self, $event) = @_;	1206	my ($self, $event) = @_;
704		1207
705	$self->grab ($event->{time}, 1)	1208	$self->grab ($event->{time}, 1)
706	or return;	1209	or return;
707		1210
…		…
729		1232
730	=item $string = $term->locale_decode ($octets)	1233	=item $string = $term->locale_decode ($octets)
731		1234
732	Convert the given locale-encoded octets into a perl string.	1235	Convert the given locale-encoded octets into a perl string.
733		1236
		1237	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1238
		1239	XORs the rendition values in the given span with the provided value
		1240	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1241	refresh hooks to provide effects similar to the selection.
		1242
		1243	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1244
		1245	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1246	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1247	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1248	it instead. Both styles I<MUST NOT> contain font styles.
		1249
		1250	=item $term->scr_bell
		1251
		1252	Ring the bell!
		1253
734	=item $term->scr_add_lines ($string)	1254	=item $term->scr_add_lines ($string)
735		1255
736	Write the given text string to the screen, as if output by the application	1256	Write the given text string to the screen, as if output by the application
737	running inside the terminal. It may not contain command sequences (escape	1257	running inside the terminal. It may not contain command sequences (escape
738	codes), but is free to use line feeds, carriage returns and tabs. The	1258	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
752		1272
753	Write the octets given in C<$data> to the tty (i.e. as program input). To	1273	Write the octets given in C<$data> to the tty (i.e. as program input). To
754	pass characters instead of octets, you should convert your strings first	1274	pass characters instead of octets, you should convert your strings first
755	to the locale-specific encoding using C<< $term->locale_encode >>.	1275	to the locale-specific encoding using C<< $term->locale_encode >>.
756		1276
		1277	=item $old_events = $term->pty_ev_events ([$new_events])
		1278
		1279	Replaces the event mask of the pty watcher by the given event mask. Can
		1280	be used to suppress input and output handling to the pty/tty. See the
		1281	description of C<< urxvt::timer->events >>. Make sure to always restore
		1282	the previous value.
		1283
757	=item $windowid = $term->parent	1284	=item $windowid = $term->parent
758		1285
759	Return the window id of the toplevel window.	1286	Return the window id of the toplevel window.
760		1287
761	=item $windowid = $term->vt	1288	=item $windowid = $term->vt
762		1289
763	Return the window id of the terminal window.	1290	Return the window id of the terminal window.
764		1291
		1292	=item $term->vt_emask_add ($x_event_mask)
		1293
		1294	Adds the specified events to the vt event mask. Useful e.g. when you want
		1295	to receive pointer events all the times:
		1296
		1297	$term->vt_emask_add (urxvt::PointerMotionMask);
		1298
765	=item $window_width = $term->width	1299	=item $window_width = $term->width
766		1300
767	=item $window_height = $term->height	1301	=item $window_height = $term->height
768		1302
769	=item $font_width = $term->fwidth	1303	=item $font_width = $term->fwidth
…		…
782		1316
783	=item $max_scrollback = $term->saveLines	1317	=item $max_scrollback = $term->saveLines
784		1318
785	=item $nrow_plus_saveLines = $term->total_rows	1319	=item $nrow_plus_saveLines = $term->total_rows
786		1320
787	=item $lines_in_scrollback = $term->nsaved	1321	=item $topmost_scrollback_row = $term->top_row
788		1322
789	Return various integers describing terminal characteristics.	1323	Return various integers describing terminal characteristics.
		1324
		1325	=item $x_display = $term->display_id
		1326
		1327	Return the DISPLAY used by rxvt-unicode.
		1328
		1329	=item $lc_ctype = $term->locale
		1330
		1331	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1332
		1333	=item $env = $term->env
		1334
		1335	Returns a copy of the environment in effect for the terminal as a hashref
		1336	similar to C<\%ENV>.
		1337
		1338	=cut
		1339
		1340	sub env {
		1341	if (my $env = $_[0]->_env) {
		1342	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1343	} else {
		1344	+{ %ENV }
		1345	}
		1346	}
790		1347
791	=item $modifiermask = $term->ModLevel3Mask	1348	=item $modifiermask = $term->ModLevel3Mask
792		1349
793	=item $modifiermask = $term->ModMetaMask	1350	=item $modifiermask = $term->ModMetaMask
794		1351
…		…
797	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1354	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
798	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1355	AltGr), the meta key (often Alt) and the num lock key, if applicable.
799		1356
800	=item $view_start = $term->view_start ([$newvalue])	1357	=item $view_start = $term->view_start ([$newvalue])
801		1358
802	Returns the negative row number of the topmost line. Minimum value is	1359	Returns the row number of the topmost displayed line. Maximum value is
803	C<0>, which displays the normal terminal contents. Larger values scroll	1360	C<0>, which displays the normal terminal contents. Lower values scroll
804	this many lines into the scrollback buffer.	1361	this many lines into the scrollback buffer.
805		1362
806	=item $term->want_refresh	1363	=item $term->want_refresh
807		1364
808	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1365	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
887	Return the row number of the first/last row of the line, respectively.	1444	Return the row number of the first/last row of the line, respectively.
888		1445
889	=item $offset = $line->offset_of ($row, $col)	1446	=item $offset = $line->offset_of ($row, $col)
890		1447
891	Returns the character offset of the given row|col pair within the logical	1448	Returns the character offset of the given row|col pair within the logical
892	line.	1449	line. Works for rows outside the line, too, and returns corresponding
		1450	offsets outside the string.
893		1451
894	=item ($row, $col) = $line->coord_of ($offset)	1452	=item ($row, $col) = $line->coord_of ($offset)
895		1453
896	Translates a string offset into terminal coordinates again.	1454	Translates a string offset into terminal coordinates again.
897		1455
898	=back	1456	=back
899		1457
900	=cut	1458	=cut
901		1459
902	sub urxvt::term::line {	1460	sub line {
903	my ($self, $row) = @_;	1461	my ($self, $row) = @_;
904		1462
905	my $maxrow = $self->nrow - 1;	1463	my $maxrow = $self->nrow - 1;
906		1464
907	my ($beg, $end) = ($row, $row);	1465	my ($beg, $end) = ($row, $row);
…		…
971	$offset / $self->{ncol} + $self->{beg},	1529	$offset / $self->{ncol} + $self->{beg},
972	$offset % $self->{ncol}	1530	$offset % $self->{ncol}
973	)	1531	)
974	}	1532	}
975		1533
976	=item ($row, $col) = $line->coord_of ($offset)
977	=item $text = $term->special_encode $string	1534	=item $text = $term->special_encode $string
978		1535
979	Converts a perl string into the special encoding used by rxvt-unicode,	1536	Converts a perl string into the special encoding used by rxvt-unicode,
980	where one character corresponds to one screen cell. See	1537	where one character corresponds to one screen cell. See
981	C<< $term->ROW_t >> for details.	1538	C<< $term->ROW_t >> for details.
…		…
983	=item $string = $term->special_decode $text	1540	=item $string = $term->special_decode $text
984		1541
985	Converts rxvt-unicodes text reprsentation into a perl string. See	1542	Converts rxvt-unicodes text reprsentation into a perl string. See
986	C<< $term->ROW_t >> for details.	1543	C<< $term->ROW_t >> for details.
987		1544
		1545	=item $success = $term->grab_button ($button, $modifiermask)
		1546
		1547	Registers a synchronous button grab. See the XGrabButton manpage.
		1548
		1549	=item $success = $term->grab ($eventtime[, $sync])
		1550
		1551	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1552	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1553
		1554	=item $term->allow_events_async
		1555
		1556	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1557
		1558	=item $term->allow_events_sync
		1559
		1560	Calls XAllowEvents with SyncBoth for the most recent grab.
		1561
		1562	=item $term->allow_events_replay
		1563
		1564	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1565	recent grab.
		1566
		1567	=item $term->ungrab
		1568
		1569	Calls XUngrab for the most recent grab. Is called automatically on
		1570	evaluation errors, as it is better to lose the grab in the error case as
		1571	the session.
		1572
988	=back	1573	=back
989		1574
		1575	=cut
		1576
		1577	package urxvt::popup;
		1578
990	=head2 The C<urxvt::popup> Class	1579	=head2 The C<urxvt::popup> Class
991		1580
992	=over 4	1581	=over 4
993		1582
994	=cut	1583	=cut
995
996	package urxvt::popup;
997		1584
998	sub add_item {	1585	sub add_item {
999	my ($self, $item) = @_;	1586	my ($self, $item) = @_;
1000		1587
		1588	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1589	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1590	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1591
		1592	$item->{render} ||= sub { $_[0]{text} };
		1593
1001	push @{ $self->{item} }, $item;	1594	push @{ $self->{item} }, $item;
1002	}	1595	}
		1596
		1597	=item $popup->add_title ($title)
		1598
		1599	Adds a non-clickable title to the popup.
		1600
		1601	=cut
		1602
		1603	sub add_title {
		1604	my ($self, $title) = @_;
		1605
		1606	$self->add_item ({
		1607	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1608	text => $title,
		1609	activate => sub { },
		1610	});
		1611	}
		1612
		1613	=item $popup->add_separator ([$sepchr])
		1614
		1615	Creates a separator, optionally using the character given as C<$sepchr>.
		1616
		1617	=cut
		1618
		1619	sub add_separator {
		1620	my ($self, $sep) = @_;
		1621
		1622	$sep ||= "=";
		1623
		1624	$self->add_item ({
		1625	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1626	text => "",
		1627	render => sub { $sep x $self->{term}->ncol },
		1628	activate => sub { },
		1629	});
		1630	}
		1631
		1632	=item $popup->add_button ($text, $cb)
		1633
		1634	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1635	selected.
		1636
		1637	=cut
1003		1638
1004	sub add_button {	1639	sub add_button {
1005	my ($self, $text, $cb) = @_;	1640	my ($self, $text, $cb) = @_;
1006		1641
1007	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,	1642	$self->add_item ({ type => "button", text => $text, activate => $cb});
1008	render => sub { $_[0]{text} },
1009	});
1010	}	1643	}
		1644
		1645	=item $popup->add_toggle ($text, $cb, $initial_value)
		1646
		1647	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1648	whenever it gets toggled, with a boolean indicating its value as its first
		1649	argument.
		1650
		1651	=cut
1011		1652
1012	sub add_toggle {	1653	sub add_toggle {
1013	my ($self, $text, $cb, $value) = @_;	1654	my ($self, $text, $cb, $value) = @_;
1014		1655
1015	$self->add_item ({ type => "button", text => " $text", value => $value,	1656	my $item; $item = {
		1657	type => "button",
		1658	text => " $text",
		1659	value => $value,
1016	render => sub { ($_[0]{value} ? "✔" : " ") . substr $_[0]{text}, 1 },	1660	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1017	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1661	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1018	});	1662	};
		1663
		1664	$self->add_item ($item);
1019	}	1665	}
		1666
		1667	=item $popup->show
		1668
		1669	Displays the popup (which is initially hidden).
		1670
		1671	=cut
1020		1672
1021	sub show {	1673	sub show {
1022	my ($self) = @_;	1674	my ($self) = @_;
1023		1675
1024	local $urxvt::popup::self = $self;	1676	local $urxvt::popup::self = $self;
1025		1677
1026	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1678	my $env = $self->{term}->env;
		1679	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1680	delete $env->{LC_ALL};
		1681	$env->{LC_CTYPE} = $self->{term}->locale;
		1682
		1683	urxvt::term->new ($env, "popup",
		1684	"--perl-lib" => "", "--perl-ext-common" => "",
		1685	"-pty-fd" => -1, "-sl" => 0,
		1686	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1027	"--transient-for" => $self->{term}->parent,	1687	"--transient-for" => $self->{term}->parent,
		1688	"-display" => $self->{term}->display_id,
1028	"-pe" => "urxvt-popup")	1689	"-pe" => "urxvt-popup")
1029	or die "unable to create popup window\n";	1690	or die "unable to create popup window\n";
1030	}	1691	}
1031		1692
1032	sub DESTROY {	1693	sub DESTROY {
1033	my ($self) = @_;	1694	my ($self) = @_;
1034		1695
		1696	delete $self->{term}{_destroy}{$self};
1035	$self->{term}->ungrab;	1697	$self->{term}->ungrab;
1036	}	1698	}
		1699
		1700	=back
		1701
		1702	=cut
		1703
		1704	package urxvt::watcher;
		1705
		1706	@urxvt::timer::ISA = __PACKAGE__;
		1707	@urxvt::iow::ISA = __PACKAGE__;
		1708	@urxvt::pw::ISA = __PACKAGE__;
		1709	@urxvt::iw::ISA = __PACKAGE__;
1037		1710
1038	=head2 The C<urxvt::timer> Class	1711	=head2 The C<urxvt::timer> Class
1039		1712
1040	This class implements timer watchers/events. Time is represented as a	1713	This class implements timer watchers/events. Time is represented as a
1041	fractional number of seconds since the epoch. Example:	1714	fractional number of seconds since the epoch. Example:
…		…
1080		1753
1081	=item $timer = $timer->start ($tstamp)	1754	=item $timer = $timer->start ($tstamp)
1082		1755
1083	Set the event trigger time to C<$tstamp> and start the timer.	1756	Set the event trigger time to C<$tstamp> and start the timer.
1084		1757
		1758	=item $timer = $timer->after ($delay)
		1759
		1760	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1761
1085	=item $timer = $timer->stop	1762	=item $timer = $timer->stop
1086		1763
1087	Stop the timer.	1764	Stop the timer.
1088		1765
1089	=back	1766	=back
…		…
1094		1771
1095	$term->{socket} = ...	1772	$term->{socket} = ...
1096	$term->{iow} = urxvt::iow	1773	$term->{iow} = urxvt::iow
1097	->new	1774	->new
1098	->fd (fileno $term->{socket})	1775	->fd (fileno $term->{socket})
1099	->events (1) # wait for read data	1776	->events (urxvt::EVENT_READ)
1100	->start	1777	->start
1101	->cb (sub {	1778	->cb (sub {
1102	my ($iow, $revents) = @_;	1779	my ($iow, $revents) = @_;
1103	# $revents must be 1 here, no need to check	1780	# $revents must be 1 here, no need to check
1104	sysread $term->{socket}, my $buf, 8192	1781	sysread $term->{socket}, my $buf, 8192
…		…
1121		1798
1122	Set the filedescriptor (not handle) to watch.	1799	Set the filedescriptor (not handle) to watch.
1123		1800
1124	=item $iow = $iow->events ($eventmask)	1801	=item $iow = $iow->events ($eventmask)
1125		1802
1126	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1803	Set the event mask to watch. The only allowed values are
1127	data, Bit #1 (value C<2>) enables watching for write data.	1804	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1805	together, or C<urxvt::EVENT_NONE>.
1128		1806
1129	=item $iow = $iow->start	1807	=item $iow = $iow->start
1130		1808
1131	Start watching for requested events on the given handle.	1809	Start watching for requested events on the given handle.
1132		1810
1133	=item $iow = $iow->stop	1811	=item $iow = $iow->stop
1134		1812
1135	Stop watching for events on the given filehandle.	1813	Stop watching for events on the given filehandle.
		1814
		1815	=back
		1816
		1817	=head2 The C<urxvt::iw> Class
		1818
		1819	This class implements idle watchers, that get called automatically when
		1820	the process is idle. They should return as fast as possible, after doing
		1821	some useful work.
		1822
		1823	=over 4
		1824
		1825	=item $iw = new urxvt::iw
		1826
		1827	Create a new idle watcher object in stopped state.
		1828
		1829	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1830
		1831	Set the callback to be called when the watcher triggers.
		1832
		1833	=item $timer = $timer->start
		1834
		1835	Start the watcher.
		1836
		1837	=item $timer = $timer->stop
		1838
		1839	Stop the watcher.
		1840
		1841	=back
		1842
		1843	=head2 The C<urxvt::pw> Class
		1844
		1845	This class implements process watchers. They create an event whenever a
		1846	process exits, after which they stop automatically.
		1847
		1848	my $pid = fork;
		1849	...
		1850	$term->{pw} = urxvt::pw
		1851	->new
		1852	->start ($pid)
		1853	->cb (sub {
		1854	my ($pw, $exit_status) = @_;
		1855	...
		1856	});
		1857
		1858	=over 4
		1859
		1860	=item $pw = new urxvt::pw
		1861
		1862	Create a new process watcher in stopped state.
		1863
		1864	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1865
		1866	Set the callback to be called when the timer triggers.
		1867
		1868	=item $pw = $timer->start ($pid)
		1869
		1870	Tells the wqtcher to start watching for process C<$pid>.
		1871
		1872	=item $pw = $pw->stop
		1873
		1874	Stop the watcher.
1136		1875
1137	=back	1876	=back
1138		1877
1139	=head1 ENVIRONMENT	1878	=head1 ENVIRONMENT
1140		1879
…		…
1143	This variable controls the verbosity level of the perl extension. Higher	1882	This variable controls the verbosity level of the perl extension. Higher
1144	numbers indicate more verbose output.	1883	numbers indicate more verbose output.
1145		1884
1146	=over 4	1885	=over 4
1147		1886
1148	=item =0 - only fatal messages	1887	=item == 0 - fatal messages
1149		1888
1150	=item =3 - script loading and management	1889	=item >= 3 - script loading and management
1151		1890
1152	=item =10 - all events received	1891	=item >=10 - all called hooks
		1892
		1893	=item >=11 - hook reutrn values
1153		1894
1154	=back	1895	=back
1155		1896
1156	=head1 AUTHOR	1897	=head1 AUTHOR
1157		1898

Diff Legend

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