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

Diff Legend

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