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.37 by root, Fri Jan 6 03:40:19 2006 UTC vs.
Revision 1.118 by root, Fri Jan 20 18:50:49 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
266	=item on_key_press $term, $event	463	=item on_x_event $term, $event
267		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_property_notify $term, $event
		482
		483	=item on_key_press $term, $event, $keysym, $octets
		484
268	=item on_key_release $term, $event	485	=item on_key_release $term, $event, $keysym
269		486
270	=item on_button_press $term, $event	487	=item on_button_press $term, $event
271		488
272	=item on_button_release $term, $event	489	=item on_button_release $term, $event
273		490
274	=item on_motion_notify $term, $event	491	=item on_motion_notify $term, $event
275		492
		493	=item on_map_notify $term, $event
		494
		495	=item on_unmap_notify $term, $event
		496
276	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
277	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.
278		499
		500	The event is a hash with most values as named by Xlib (see the XEvent
		501	manpage), with the additional members C<row> and C<col>, which are the row
		502	and column under the mouse cursor.
		503
		504	C<on_key_press> additionally receives the string rxvt-unicode would
		505	output, if any, in locale-specific encoding.
		506
279	subwindow.	507	subwindow.
280		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
281	=back	518	=back
282		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
283	=head2 Variables in the C<urxvt> Package	543	=head2 Variables in the C<urxvt> Package
284		544
285	=over 4	545	=over 4
286		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>.
		559
287	=item $urxvt::TERM	560	=item $urxvt::TERM
288		561
289	The current terminal. Whenever a callback/Hook is bein executed, this	562	The current terminal. This variable stores the current C<urxvt::term>
290	variable stores the current C<urxvt::term> object.	563	object, whenever a callback/hook is executing.
		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>.
291		580
292	=back	581	=back
293		582
294	=head2 Functions in the C<urxvt> Package	583	=head2 Functions in the C<urxvt> Package
295		584
296	=over 4	585	=over 4
297
298	=item $term = new urxvt [arg...]
299
300	Creates a new terminal, very similar as if you had started it with
301	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
302	if the new instance couldn't be created. Returns C<undef> if the new
303	instance didn't initialise perl, and the terminal object otherwise. The
304	C<init> and C<start> hooks will be called during the call.
305		586
306	=item urxvt::fatal $errormessage	587	=item urxvt::fatal $errormessage
307		588
308	Fatally aborts execution with the given error message. Avoid at all	589	Fatally aborts execution with the given error message. Avoid at all
309	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
…		…
316	that calls this function.	597	that calls this function.
317		598
318	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
319	correct place, e.g. on stderr of the connecting urxvtc client.	600	correct place, e.g. on stderr of the connecting urxvtc client.
320		601
		602	Messages have a size limit of 1023 bytes currently.
		603
321	=item $time = urxvt::NOW	604	=item $time = urxvt::NOW
322		605
323	Returns the "current time" (as per the event loop).	606	Returns the "current time" (as per the event loop).
		607
		608	=item urxvt::CurrentTime
		609
		610	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		611	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		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
		629
		630	Various constants for use in X calls and event processing.
324		631
325	=back	632	=back
326		633
327	=head2 RENDITION	634	=head2 RENDITION
328		635
…		…
355		662
356	=item $background = urxvt::GET_BASEBG $rend	663	=item $background = urxvt::GET_BASEBG $rend
357		664
358	Return the foreground/background colour index, respectively.	665	Return the foreground/background colour index, respectively.
359		666
360	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	667	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
361		668
362	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	669	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
363		670
364	Replace the foreground/background colour in the rendition mask with the	671	Replace the foreground/background colour in the rendition mask with the
365	specified one.	672	specified one.
366		673
367	=item $value = urxvt::GET_CUSTOM ($rend)	674	=item $value = urxvt::GET_CUSTOM $rend
368		675
369	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
370	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
371	zero.	678	zero.
372		679
373	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	680	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
374		681
375	Change the custom value.	682	Change the custom value.
376		683
377	=back	684	=back
378		685
379	=cut	686	=cut
380		687
381	package urxvt;
382
383	use strict;
384	use Scalar::Util ();
385
386	our $TERM;
387	our @HOOKNAME;
388	our $LIBDIR;
389
390	BEGIN {	688	BEGIN {
391	urxvt->bootstrap;
392
393	# overwrite perl's warn	689	# overwrite perl's warn
394	*CORE::GLOBAL::warn = sub {	690	*CORE::GLOBAL::warn = sub {
395	my $msg = join "", @_;	691	my $msg = join "", @_;
396	$msg .= "\n"	692	$msg .= "\n"
397	unless $msg =~ /\n$/;	693	unless $msg =~ /\n$/;
398	urxvt::warn ($msg);	694	urxvt::warn ($msg);
399	};	695	};
400	}	696	}
401		697
402	my @hook_count;
403	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	698	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
404		699
405	sub verbose {	700	sub verbose {
406	my ($level, $msg) = @_;	701	my ($level, $msg) = @_;
407	warn "$msg\n" if $level <= $verbosity;	702	warn "$msg\n" if $level <= $verbosity;
408	}	703	}
409		704
410	# find on_xxx subs in the package and register them	705	my %extension_pkg;
411	# as hooks
412	sub register_package($) {
413	my ($pkg) = @_;
414
415	for my $htype (0.. $#HOOKNAME) {
416	my $name = $HOOKNAME[$htype];
417
418	my $ref = $pkg->can ("on_" . lc $name)
419	or next;
420
421	$TERM->{_hook}[$htype]{$pkg} = $ref;
422	$hook_count[$htype]++
423	or set_should_invoke $htype, 1;
424	}
425	}
426
427	my $script_pkg = "script0000";
428	my %script_pkg;
429		706
430	# load a single script into its own package, once only	707	# load a single script into its own package, once only
431	sub script_package($) {	708	sub extension_package($) {
432	my ($path) = @_;	709	my ($path) = @_;
433		710
434	$script_pkg{$path} ||= do {	711	$extension_pkg{$path} ||= do {
435	my $pkg = "urxvt::" . ($script_pkg++);	712	$path =~ /([^\/\\]+)$/;
		713	my $pkg = $1;
		714	$pkg =~ s/[^[:word:]]/_/g;
		715	$pkg = "urxvt::ext::$pkg";
436		716
437	verbose 3, "loading script '$path' into package '$pkg'";	717	verbose 3, "loading extension '$path' into package '$pkg'";
438		718
439	open my $fh, "<:raw", $path	719	open my $fh, "<:raw", $path
440	or die "$path: $!";	720	or die "$path: $!";
441		721
		722	my $source =
442	my $source = "package $pkg; use strict; use utf8;\n"	723	"package $pkg; use strict; use utf8;\n"
443	. "#line 1 \"$path\"\n{\n"	724	. "#line 1 \"$path\"\n{\n"
444	. (do { local $/; <$fh> })	725	. (do { local $/; <$fh> })
445	. "\n};\n1";	726	. "\n};\n1";
446		727
		728	eval $source
447	eval $source or die "$path: $@";	729	or die "$path: $@";
448		730
449	$pkg	731	$pkg
450	}	732	}
451	}	733	}
452		734
…		…
457	local $TERM = shift;	739	local $TERM = shift;
458	my $htype = shift;	740	my $htype = shift;
459		741
460	if ($htype == 0) { # INIT	742	if ($htype == 0) { # INIT
461	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	743	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		744
		745	my %ext_arg;
462		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
463	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	756	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		757	if ($_ eq "default") {
		758	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
		759	} elsif (/^-(.*)$/) {
		760	delete $ext_arg{$1};
		761	} elsif (/^([^<]+)<(.*)>$/) {
		762	push @{ $ext_arg{$1} }, $2;
		763	} else {
		764	$ext_arg{$_} ||= [];
		765	}
		766	}
		767
		768	while (my ($ext, $argv) = each %ext_arg) {
464	my @files = grep -f $_, map "$_/$ext", @dirs;	769	my @files = grep -f $_, map "$_/$ext", @dirs;
465		770
466	if (@files) {	771	if (@files) {
467	register_package script_package $files[0];	772	$TERM->register_package (extension_package $files[0], $argv);
468	} else {	773	} else {
469	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";
470	}	775	}
471	}	776	}
		777
		778	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		779	warn $@ if $@;
472	}	780	}
473		781
474	$retval = undef;	782	$retval = undef;
475		783
476	if (my $cb = $TERM->{_hook}[$htype]) {	784	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
478	if $verbosity >= 10;	786	if $verbosity >= 10;
479		787
480	keys %$cb;	788	keys %$cb;
481		789
482	while (my ($pkg, $cb) = each %$cb) {	790	while (my ($pkg, $cb) = each %$cb) {
483	$retval = $cb->(	791	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
484	$TERM->{_pkg}{$pkg} ||= do {	792	$retval ||= $retval_;
485	my $proxy = bless { }, urxvt::term::proxy::;
486	Scalar::Util::weaken ($proxy->{term} = $TERM);
487	$proxy
488	},
489	@_,
490	) and last;
491	}
492	}
493		793
494	if ($htype == 1) { # DESTROY	794	if ($@) {
495	# remove hooks if unused	795	$TERM->ungrab; # better to lose the grab than the session
496	if (my $hook = $TERM->{_hook}) {	796	warn $@;
497	for my $htype (0..$#$hook) {
498	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
499	or set_should_invoke $htype, 0;
500	}	797	}
501	}	798	}
502		799
		800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		801	if $verbosity >= 11;
		802	}
		803
		804	if ($htype == 1) { # DESTROY
503	# clear package objects	805	# clear package objects
504	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
505		807
506	# clear package	808	# clear package
507	%$TERM = ();	809	%$TERM = ();
508	}	810	}
509		811
510	$retval	812	$retval
511	}	813	}
512		814
513	sub urxvt::term::proxy::AUTOLOAD {	815	# urxvt::term::extension
514	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	816
		817	package urxvt::term::extension;
		818
		819	sub enable {
		820	my ($self, %hook) = @_;
		821	my $pkg = $self->{_pkg};
		822
		823	while (my ($name, $cb) = each %hook) {
		824	my $htype = $HOOKTYPE{uc $name};
		825	defined $htype
		826	or Carp::croak "unsupported hook type '$name'";
		827
		828	$self->set_should_invoke ($htype, +1)
		829	unless exists $self->{term}{_hook}[$htype]{$pkg};
		830
		831	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		832	}
		833	}
		834
		835	sub disable {
		836	my ($self, @hook) = @_;
		837	my $pkg = $self->{_pkg};
		838
		839	for my $name (@hook) {
		840	my $htype = $HOOKTYPE{uc $name};
		841	defined $htype
		842	or Carp::croak "unsupported hook type '$name'";
		843
		844	$self->set_should_invoke ($htype, -1)
		845	if delete $self->{term}{_hook}[$htype]{$pkg};
		846	}
		847	}
		848
		849	our $AUTOLOAD;
		850
		851	sub AUTOLOAD {
		852	$AUTOLOAD =~ /:([^:]+)$/
515	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	853	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
516		854
517	eval qq{	855	eval qq{
518	sub $urxvt::term::proxy::AUTOLOAD {	856	sub $AUTOLOAD {
519	my \$proxy = shift;	857	my \$proxy = shift;
520	\$proxy->{term}->$1 (\@_)	858	\$proxy->{term}->$1 (\@_)
521	}	859	}
522	1	860	1
523	} or die "FATAL: unable to compile method forwarder: $@";	861	} or die "FATAL: unable to compile method forwarder: $@";
524		862
525	goto &$urxvt::term::proxy::AUTOLOAD;	863	goto &$AUTOLOAD;
526	}	864	}
		865
		866	sub DESTROY {
		867	# nop
		868	}
		869
		870	# urxvt::destroy_hook
		871
		872	sub urxvt::destroy_hook::DESTROY {
		873	${$_[0]}->();
		874	}
		875
		876	sub urxvt::destroy_hook(&) {
		877	bless \shift, urxvt::destroy_hook::
		878	}
		879
		880	package urxvt::anyevent;
		881
		882	=head2 The C<urxvt::anyevent> Class
		883
		884	The sole purpose of this class is to deliver an interface to the
		885	C<AnyEvent> module - any module using it will work inside urxvt without
		886	further programming. The only exception is that you cannot wait on
		887	condition variables, but non-blocking condvar use is ok. What this means
		888	is that you cannot use blocking APIs, but the non-blocking variant should
		889	work.
		890
		891	=cut
		892
		893	our $VERSION = 1;
		894
		895	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		896	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		897
		898	sub timer {
		899	my ($class, %arg) = @_;
		900
		901	my $cb = $arg{cb};
		902
		903	urxvt::timer
		904	->new
		905	->start (urxvt::NOW + $arg{after})
		906	->cb (sub {
		907	$_[0]->stop; # need to cancel manually
		908	$cb->();
		909	})
		910	}
		911
		912	sub io {
		913	my ($class, %arg) = @_;
		914
		915	my $cb = $arg{cb};
		916
		917	bless [$arg{fh}, urxvt::iow
		918	->new
		919	->fd (fileno $arg{fh})
		920	->events (($arg{poll} =~ /r/ ? 1 : 0)
		921	| ($arg{poll} =~ /w/ ? 2 : 0))
		922	->start
		923	->cb (sub {
		924	$cb->(($_[1] & 1 ? 'r' : '')
		925	. ($_[1] & 2 ? 'w' : ''));
		926	})],
		927	urxvt::anyevent::
		928	}
		929
		930	sub DESTROY {
		931	$_[0][1]->stop;
		932	}
		933
		934	sub condvar {
		935	bless \my $flag, urxvt::anyevent::condvar::
		936	}
		937
		938	sub urxvt::anyevent::condvar::broadcast {
		939	${$_[0]}++;
		940	}
		941
		942	sub urxvt::anyevent::condvar::wait {
		943	unless (${$_[0]}) {
		944	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		945	}
		946	}
		947
		948	package urxvt::term;
527		949
528	=head2 The C<urxvt::term> Class	950	=head2 The C<urxvt::term> Class
529		951
530	=over 4	952	=over 4
531		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
532	=item $term->destroy	1001	=item $term->destroy
533		1002
534	Destroy the terminal object (close the window, free resources etc.).	1003	Destroy the terminal object (close the window, free resources
		1004	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1005	watchers (timers, io watchers) are still active.
		1006
		1007	=item $term->exec_async ($cmd[, @args])
		1008
		1009	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1010	("starts") programs in the background. This function takes care of setting
		1011	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1012	be preferred over explicit calls to C<exec> or C<system>.
		1013
		1014	Returns the pid of the subprocess or C<undef> on error.
		1015
		1016	=cut
		1017
		1018	sub exec_async {
		1019	my $self = shift;
		1020
		1021	my $pid = fork;
		1022
		1023	return $pid
		1024	if !defined $pid or $pid;
		1025
		1026	%ENV = %{ $self->env };
		1027
		1028	exec @_;
		1029	urxvt::_exit 255;
		1030	}
		1031
		1032	=item $isset = $term->option ($optval[, $set])
		1033
		1034	Returns true if the option specified by C<$optval> is enabled, and
		1035	optionally change it. All option values are stored by name in the hash
		1036	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1037
		1038	Here is a a likely non-exhaustive list of option names, please see the
		1039	source file F</src/optinc.h> to see the actual list:
		1040
		1041	borderLess console cursorBlink cursorUnderline hold iconic insecure
		1042	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		1043	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		1044	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		1045	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		1046	transparent tripleclickwords utmpInhibit visualBell
535		1047
536	=item $value = $term->resource ($name[, $newval])	1048	=item $value = $term->resource ($name[, $newval])
537		1049
538	Returns the current resource value associated with a given name and	1050	Returns the current resource value associated with a given name and
539	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>
…		…
549		1061
550	Please note that resource strings will currently only be freed when the	1062	Please note that resource strings will currently only be freed when the
551	terminal is destroyed, so changing options frequently will eat memory.	1063	terminal is destroyed, so changing options frequently will eat memory.
552		1064
553	Here is a a likely non-exhaustive list of resource names, not all of which	1065	Here is a a likely non-exhaustive list of resource names, not all of which
554	are supported in every build, please see the source to see the actual	1066	are supported in every build, please see the source file F</src/rsinc.h>
555	list:	1067	to see the actual list:
556		1068
557	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1069	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
558	borderLess color cursorBlink cursorUnderline cutchars delete_key	1070	borderLess color cursorBlink cursorUnderline cutchars delete_key
559	display_name embed ext_bwidth fade font geometry hold iconName	1071	display_name embed ext_bwidth fade font geometry hold iconName
560	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1072	imFont imLocale inputMethod insecure int_bwidth intensityStyles
561	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1073	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
562	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1074	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
563	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1075	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
564	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1076	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
565	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1077	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
566	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1078	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
567	shade term_name title transparent transparent_all tripleclickwords	1079	secondaryScreen secondaryScroll selectstyle shade term_name title
568	utmpInhibit visualBell	1080	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1081	visualBell
569		1082
570	=cut	1083	=cut
571		1084
572	sub urxvt::term::resource($$;$) {	1085	sub resource($$;$) {
573	my ($self, $name) = (shift, shift);	1086	my ($self, $name) = (shift, shift);
574	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1087	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
575	goto &urxvt::term::_resource;	1088	&urxvt::term::_resource
576	}	1089	}
		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.
577		1106
578	=item $rend = $term->rstyle ([$new_rstyle])	1107	=item $rend = $term->rstyle ([$new_rstyle])
579		1108
580	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
581	the terminal application will use this style.	1110	the terminal application will use this style.
…		…
592	=item ($row, $col) = $term->selection_end ([$row, $col])	1121	=item ($row, $col) = $term->selection_end ([$row, $col])
593		1122
594	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,
595	and optionally set them to new values.	1124	and optionally set them to new values.
596		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
597	=item $success = $term->selection_grab ($eventtime)	1133	=item $success = $term->selection_grab ($eventtime)
598		1134
599	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
600	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.
601		1138
602	=item $oldtext = $term->selection ([$newtext])	1139	=item $oldtext = $term->selection ([$newtext])
603		1140
604	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>.
605		1142
606	#=item $term->overlay ($x, $y, $text)	1143	=item $term->overlay_simple ($x, $y, $text)
607	#	1144
608	#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.
609	#	1146
610	#=cut	1147	=cut
611	#	1148
612	#sub urxvt::term::scr_overlay {	1149	sub overlay_simple {
613	# my ($self, $x, $y, $text) = @_;	1150	my ($self, $x, $y, $text) = @_;
614	#	1151
615	# my @lines = split /\n/, $text;	1152	my @lines = split /\n/, $text;
616	#	1153
617	# my $w = 0;	1154	my $w = List::Util::max map $self->strwidth ($_), @lines;
618	# for (map $self->strwidth ($_), @lines) {	1155
619	# $w = $_ if $w < $_;
620	# }
621	#
622	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1156	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
623	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1157	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
624	#}	1158
		1159	$overlay
		1160	}
625		1161
626	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1162	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
627		1163
628	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
629	width/height. C<$rstyle> defines the initial rendition style	1165	width/height. C<$rstyle> defines the initial rendition style
…		…
656		1192
657	If hidden, display the overlay again.	1193	If hidden, display the overlay again.
658		1194
659	=back	1195	=back
660		1196
		1197	=item $popup = $term->popup ($event)
		1198
		1199	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1200	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1201	currently).
		1202
		1203	=cut
		1204
		1205	sub popup {
		1206	my ($self, $event) = @_;
		1207
		1208	$self->grab ($event->{time}, 1)
		1209	or return;
		1210
		1211	my $popup = bless {
		1212	term => $self,
		1213	event => $event,
		1214	}, urxvt::popup::;
		1215
		1216	Scalar::Util::weaken $popup->{term};
		1217
		1218	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1219	Scalar::Util::weaken $self->{_destroy}{$popup};
		1220
		1221	$popup
		1222	}
		1223
661	=item $cellwidth = $term->strwidth $string	1224	=item $cellwidth = $term->strwidth ($string)
662		1225
663	Returns the number of screen-cells this string would need. Correctly	1226	Returns the number of screen-cells this string would need. Correctly
664	accounts for wide and combining characters.	1227	accounts for wide and combining characters.
665		1228
666	=item $octets = $term->locale_encode $string	1229	=item $octets = $term->locale_encode ($string)
667		1230
668	Convert the given text string into the corresponding locale encoding.	1231	Convert the given text string into the corresponding locale encoding.
669		1232
670	=item $string = $term->locale_decode $octets	1233	=item $string = $term->locale_decode ($octets)
671		1234
672	Convert the given locale-encoded octets into a perl string.	1235	Convert the given locale-encoded octets into a perl string.
		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!
673		1253
674	=item $term->scr_add_lines ($string)	1254	=item $term->scr_add_lines ($string)
675		1255
676	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
677	running inside the terminal. It may not contain command sequences (escape	1257	running inside the terminal. It may not contain command sequences (escape
…		…
692		1272
693	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
694	pass characters instead of octets, you should convert your strings first	1274	pass characters instead of octets, you should convert your strings first
695	to the locale-specific encoding using C<< $term->locale_encode >>.	1275	to the locale-specific encoding using C<< $term->locale_encode >>.
696		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
		1284	=item $windowid = $term->parent
		1285
		1286	Return the window id of the toplevel window.
		1287
		1288	=item $windowid = $term->vt
		1289
		1290	Return the window id of the terminal window.
		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
697	=item $window_width = $term->width	1299	=item $window_width = $term->width
698		1300
699	=item $window_height = $term->height	1301	=item $window_height = $term->height
700		1302
701	=item $font_width = $term->fwidth	1303	=item $font_width = $term->fwidth
…		…
714		1316
715	=item $max_scrollback = $term->saveLines	1317	=item $max_scrollback = $term->saveLines
716		1318
717	=item $nrow_plus_saveLines = $term->total_rows	1319	=item $nrow_plus_saveLines = $term->total_rows
718		1320
719	=item $lines_in_scrollback = $term->nsaved	1321	=item $topmost_scrollback_row = $term->top_row
720		1322
721	Return various integers describing terminal characteristics.	1323	Return various integers describing terminal characteristics.
722		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	}
		1347
		1348	=item $modifiermask = $term->ModLevel3Mask
		1349
		1350	=item $modifiermask = $term->ModMetaMask
		1351
		1352	=item $modifiermask = $term->ModNumLockMask
		1353
		1354	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1355	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1356
723	=item $view_start = $term->view_start ([$newvalue])	1357	=item $view_start = $term->view_start ([$newvalue])
724		1358
725	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
726	C<0>, which displays the normal terminal contents. Larger values scroll	1360	C<0>, which displays the normal terminal contents. Lower values scroll
727	this many lines into the scrollback buffer.	1361	this many lines into the scrollback buffer.
728		1362
729	=item $term->want_refresh	1363	=item $term->want_refresh
730		1364
731	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1365	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
810	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.
811		1445
812	=item $offset = $line->offset_of ($row, $col)	1446	=item $offset = $line->offset_of ($row, $col)
813		1447
814	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
815	line.	1449	line. Works for rows outside the line, too, and returns corresponding
		1450	offsets outside the string.
816		1451
817	=item ($row, $col) = $line->coord_of ($offset)	1452	=item ($row, $col) = $line->coord_of ($offset)
818		1453
819	Translates a string offset into terminal coordinates again.	1454	Translates a string offset into terminal coordinates again.
820		1455
821	=back	1456	=back
822		1457
823	=cut	1458	=cut
824		1459
825	sub urxvt::term::line {	1460	sub line {
826	my ($self, $row) = @_;	1461	my ($self, $row) = @_;
827		1462
828	my $maxrow = $self->nrow - 1;	1463	my $maxrow = $self->nrow - 1;
829		1464
830	my ($beg, $end) = ($row, $row);	1465	my ($beg, $end) = ($row, $row);
…		…
894	$offset / $self->{ncol} + $self->{beg},	1529	$offset / $self->{ncol} + $self->{beg},
895	$offset % $self->{ncol}	1530	$offset % $self->{ncol}
896	)	1531	)
897	}	1532	}
898		1533
899	=item ($row, $col) = $line->coord_of ($offset)
900	=item $text = $term->special_encode $string	1534	=item $text = $term->special_encode $string
901		1535
902	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,
903	where one character corresponds to one screen cell. See	1537	where one character corresponds to one screen cell. See
904	C<< $term->ROW_t >> for details.	1538	C<< $term->ROW_t >> for details.
…		…
906	=item $string = $term->special_decode $text	1540	=item $string = $term->special_decode $text
907		1541
908	Converts rxvt-unicodes text reprsentation into a perl string. See	1542	Converts rxvt-unicodes text reprsentation into a perl string. See
909	C<< $term->ROW_t >> for details.	1543	C<< $term->ROW_t >> for details.
910		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
911	=back	1573	=back
		1574
		1575	=cut
		1576
		1577	package urxvt::popup;
		1578
		1579	=head2 The C<urxvt::popup> Class
		1580
		1581	=over 4
		1582
		1583	=cut
		1584
		1585	sub add_item {
		1586	my ($self, $item) = @_;
		1587
		1588	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1589	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1590	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1591
		1592	$item->{render} ||= sub { $_[0]{text} };
		1593
		1594	push @{ $self->{item} }, $item;
		1595	}
		1596
		1597	=item $popup->add_title ($title)
		1598
		1599	Adds a non-clickable title to the popup.
		1600
		1601	=cut
		1602
		1603	sub add_title {
		1604	my ($self, $title) = @_;
		1605
		1606	$self->add_item ({
		1607	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1608	text => $title,
		1609	activate => sub { },
		1610	});
		1611	}
		1612
		1613	=item $popup->add_separator ([$sepchr])
		1614
		1615	Creates a separator, optionally using the character given as C<$sepchr>.
		1616
		1617	=cut
		1618
		1619	sub add_separator {
		1620	my ($self, $sep) = @_;
		1621
		1622	$sep ||= "=";
		1623
		1624	$self->add_item ({
		1625	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1626	text => "",
		1627	render => sub { $sep x $self->{term}->ncol },
		1628	activate => sub { },
		1629	});
		1630	}
		1631
		1632	=item $popup->add_button ($text, $cb)
		1633
		1634	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1635	selected.
		1636
		1637	=cut
		1638
		1639	sub add_button {
		1640	my ($self, $text, $cb) = @_;
		1641
		1642	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1643	}
		1644
		1645	=item $popup->add_toggle ($text, $cb, $initial_value)
		1646
		1647	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1648	whenever it gets toggled, with a boolean indicating its value as its first
		1649	argument.
		1650
		1651	=cut
		1652
		1653	sub add_toggle {
		1654	my ($self, $text, $cb, $value) = @_;
		1655
		1656	my $item; $item = {
		1657	type => "button",
		1658	text => " $text",
		1659	value => $value,
		1660	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1661	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1662	};
		1663
		1664	$self->add_item ($item);
		1665	}
		1666
		1667	=item $popup->show
		1668
		1669	Displays the popup (which is initially hidden).
		1670
		1671	=cut
		1672
		1673	sub show {
		1674	my ($self) = @_;
		1675
		1676	local $urxvt::popup::self = $self;
		1677
		1678	my $env = $self->{term}->env;
		1679	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1680	delete $env->{LC_ALL};
		1681	$env->{LC_CTYPE} = $self->{term}->locale;
		1682
		1683	urxvt::term->new ($env, "popup",
		1684	"--perl-lib" => "", "--perl-ext-common" => "",
		1685	"-pty-fd" => -1, "-sl" => 0,
		1686	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		1687	"--transient-for" => $self->{term}->parent,
		1688	"-display" => $self->{term}->display_id,
		1689	"-pe" => "urxvt-popup")
		1690	or die "unable to create popup window\n";
		1691	}
		1692
		1693	sub DESTROY {
		1694	my ($self) = @_;
		1695
		1696	delete $self->{term}{_destroy}{$self};
		1697	$self->{term}->ungrab;
		1698	}
		1699
		1700	=back
		1701
		1702	=cut
		1703
		1704	package urxvt::watcher;
		1705
		1706	@urxvt::timer::ISA = __PACKAGE__;
		1707	@urxvt::iow::ISA = __PACKAGE__;
		1708	@urxvt::pw::ISA = __PACKAGE__;
		1709	@urxvt::iw::ISA = __PACKAGE__;
912		1710
913	=head2 The C<urxvt::timer> Class	1711	=head2 The C<urxvt::timer> Class
914		1712
915	This class implements timer watchers/events. Time is represented as a	1713	This class implements timer watchers/events. Time is represented as a
916	fractional number of seconds since the epoch. Example:	1714	fractional number of seconds since the epoch. Example:
…		…
955		1753
956	=item $timer = $timer->start ($tstamp)	1754	=item $timer = $timer->start ($tstamp)
957		1755
958	Set the event trigger time to C<$tstamp> and start the timer.	1756	Set the event trigger time to C<$tstamp> and start the timer.
959		1757
		1758	=item $timer = $timer->after ($delay)
		1759
		1760	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1761
960	=item $timer = $timer->stop	1762	=item $timer = $timer->stop
961		1763
962	Stop the timer.	1764	Stop the timer.
963		1765
964	=back	1766	=back
…		…
969		1771
970	$term->{socket} = ...	1772	$term->{socket} = ...
971	$term->{iow} = urxvt::iow	1773	$term->{iow} = urxvt::iow
972	->new	1774	->new
973	->fd (fileno $term->{socket})	1775	->fd (fileno $term->{socket})
974	->events (1) # wait for read data	1776	->events (urxvt::EVENT_READ)
975	->start	1777	->start
976	->cb (sub {	1778	->cb (sub {
977	my ($iow, $revents) = @_;	1779	my ($iow, $revents) = @_;
978	# $revents must be 1 here, no need to check	1780	# $revents must be 1 here, no need to check
979	sysread $term->{socket}, my $buf, 8192	1781	sysread $term->{socket}, my $buf, 8192
…		…
996		1798
997	Set the filedescriptor (not handle) to watch.	1799	Set the filedescriptor (not handle) to watch.
998		1800
999	=item $iow = $iow->events ($eventmask)	1801	=item $iow = $iow->events ($eventmask)
1000		1802
1001	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1803	Set the event mask to watch. The only allowed values are
1002	data, Bit #1 (value C<2>) enables watching for write data.	1804	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1805	together, or C<urxvt::EVENT_NONE>.
1003		1806
1004	=item $iow = $iow->start	1807	=item $iow = $iow->start
1005		1808
1006	Start watching for requested events on the given handle.	1809	Start watching for requested events on the given handle.
1007		1810
1008	=item $iow = $iow->stop	1811	=item $iow = $iow->stop
1009		1812
1010	Stop watching for events on the given filehandle.	1813	Stop watching for events on the given filehandle.
		1814
		1815	=back
		1816
		1817	=head2 The C<urxvt::iw> Class
		1818
		1819	This class implements idle watchers, that get called automatically when
		1820	the process is idle. They should return as fast as possible, after doing
		1821	some useful work.
		1822
		1823	=over 4
		1824
		1825	=item $iw = new urxvt::iw
		1826
		1827	Create a new idle watcher object in stopped state.
		1828
		1829	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1830
		1831	Set the callback to be called when the watcher triggers.
		1832
		1833	=item $timer = $timer->start
		1834
		1835	Start the watcher.
		1836
		1837	=item $timer = $timer->stop
		1838
		1839	Stop the watcher.
		1840
		1841	=back
		1842
		1843	=head2 The C<urxvt::pw> Class
		1844
		1845	This class implements process watchers. They create an event whenever a
		1846	process exits, after which they stop automatically.
		1847
		1848	my $pid = fork;
		1849	...
		1850	$term->{pw} = urxvt::pw
		1851	->new
		1852	->start ($pid)
		1853	->cb (sub {
		1854	my ($pw, $exit_status) = @_;
		1855	...
		1856	});
		1857
		1858	=over 4
		1859
		1860	=item $pw = new urxvt::pw
		1861
		1862	Create a new process watcher in stopped state.
		1863
		1864	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1865
		1866	Set the callback to be called when the timer triggers.
		1867
		1868	=item $pw = $timer->start ($pid)
		1869
		1870	Tells the wqtcher to start watching for process C<$pid>.
		1871
		1872	=item $pw = $pw->stop
		1873
		1874	Stop the watcher.
1011		1875
1012	=back	1876	=back
1013		1877
1014	=head1 ENVIRONMENT	1878	=head1 ENVIRONMENT
1015		1879
…		…
1018	This variable controls the verbosity level of the perl extension. Higher	1882	This variable controls the verbosity level of the perl extension. Higher
1019	numbers indicate more verbose output.	1883	numbers indicate more verbose output.
1020		1884
1021	=over 4	1885	=over 4
1022		1886
1023	=item =0 - only fatal messages	1887	=item == 0 - fatal messages
1024		1888
1025	=item =3 - script loading and management	1889	=item >= 3 - script loading and management
1026		1890
1027	=item =10 - all events received	1891	=item >=10 - all called hooks
		1892
		1893	=item >=11 - hook reutrn values
1028		1894
1029	=back	1895	=back
1030		1896
1031	=head1 AUTHOR	1897	=head1 AUTHOR
1032		1898

Diff Legend

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