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

Diff Legend

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