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.36 by root, Fri Jan 6 02:58:02 2006 UTC vs.
Revision 1.117 by ayin, Fri Jan 20 18:02:43 2006 UTC

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

Diff Legend

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