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

Diff Legend

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