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.53 by root, Sun Jan 8 01:16:09 2006 UTC vs.
Revision 1.125 by root, Sun Jan 22 20:39:47 2006 UTC

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

Diff Legend

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