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

Diff Legend

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