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.14 by root, Tue Jan 3 01:15:00 2006 UTC vs.
Revision 1.114 by root, Fri Jan 20 12:16:28 2006 UTC

		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
…		…
15		17
16	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
17		19
18	=head1 DESCRIPTION	20	=head1 DESCRIPTION
19		21
20	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
21	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
22		24
23	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
24	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
25		27
26	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
27	scripts will be shared (But not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
		30
		31	=head1 PREPACKAGED EXTENSIONS
		32
		33	This section describes the extensions delivered with this release. You can
		34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		35
		36	You can activate them like this:
		37
		38	@@RXVT_NAME@@ -pe <extensionname>
		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
		44	=over 4
		45
		46	=item selection (enabled by default)
		47
		48	(More) intelligent selection. This extension tries to be more intelligent
		49	when the user extends selections (double-click and further clicks). Right
		50	now, it tries to select words, urls and complete shell-quoted
		51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
		53
		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:
		76
		77	=over 4
		78
		79	=item rot13
		80
		81	Rot-13 the selection when activated. Used via keyboard trigger:
		82
		83	URxvt.keysym.C-M-r: perl:selection:rot13
		84
		85	=back
		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
		188	=item digital-clock
		189
		190	Displays a digital clock using the built-in overlay.
		191
		192	=item example-refresh-hooks
		193
		194	Displays a very simple digital clock in the upper right corner of the
		195	window. Illustrates overwriting the refresh callbacks to create your own
		196	overlays or changes.
		197
		198	=item selection-pastebin
		199
		200	This is a little rarely useful extension that Uploads the selection as
		201	textfile to a remote site (or does other things). (The implementation is
		202	not currently secure for use in a multiuser environment as it writes to
		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/%
		226
		227	=back
		228
		229	=head1 API DOCUMENTATION
28		230
29	=head2 General API Considerations	231	=head2 General API Considerations
30		232
31	All objects (such as terminals, time watchers etc.) are typical	233	All objects (such as terminals, time watchers etc.) are typical
32	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
33	like. All members starting with an underscore (such as C<_ptr> or	235	like. All members starting with an underscore (such as C<_ptr> or
34	C<_hook>) are reserved for internal uses and must not be accessed or	236	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
35	modified).	237	modified).
36		238
37	When objects are destroyed on the C++ side, the perl object hashes are	239	When objects are destroyed on the C++ side, the perl object hashes are
38	emptied, so its best to store related objects such as time watchers and	240	emptied, so its best to store related objects such as time watchers and
39	the like inside the terminal object so they get destroyed as soon as the	241	the like inside the terminal object so they get destroyed as soon as the
40	terminal is destroyed.	242	terminal is destroyed.
41		243
		244	Argument names also often indicate the type of a parameter. Here are some
		245	hints on what they mean:
		246
		247	=over 4
		248
		249	=item $text
		250
		251	Rxvt-unicodes special way of encoding text, where one "unicode" character
		252	always represents one screen cell. See L<ROW_t> for a discussion of this format.
		253
		254	=item $string
		255
		256	A perl text string, with an emphasis on I<text>. It can store all unicode
		257	characters and is to be distinguished with text encoded in a specific
		258	encoding (often locale-specific) and binary data.
		259
		260	=item $octets
		261
		262	Either binary data or - more common - a text string encoded in a
		263	locale-specific way.
		264
		265	=back
		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
42	=head2 Hooks	300	=head2 Hooks
43		301
44	The following subroutines can be declared in loaded scripts, and will be called	302	The following subroutines can be declared in extension files, and will be
45	whenever the relevant event happens.	303	called whenever the relevant event happens.
46		304
47	All of them must return a boolean value. If it is true, then the event	305	The first argument passed to them is an extension oject as described in
48	counts as being I<consumed>, and the invocation of other hooks is skipped,	306	the in the C<Extension Objects> section.
		307
		308	B<All> of these hooks must return a boolean value. If any of the called
		309	hooks returns true, then the event counts as being I<consumed>, and the
49	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.
50		311
51	When in doubt, return a false value (preferably C<()>).	312	I<< When in doubt, return a false value (preferably C<()>). >>
52		313
53	=over 4	314	=over 4
54		315
55	=item on_init $term	316	=item on_init $term
56		317
57	Called after a new terminal object has been initialized, but before	318	Called after a new terminal object has been initialized, but before
58	windows are created or the command gets run.	319	windows are created or the command gets run. Most methods are unsafe to
		320	call or deliver senseless data, as terminal size and other characteristics
		321	have not yet been determined. You can safely query and change resources
		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.
59		335
60	=item on_reset $term	336	=item on_reset $term
61		337
62	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
63	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
64	variables.	340	variables.
65		341
66	=item on_start $term	342	=item on_child_start $term, $pid
67		343
68	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.
69	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>.
70		350
71	=item on_sel_make $term, $eventtime	351	=item on_sel_make $term, $eventtime
72		352
73	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
74	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
…		…
83	requested from the server. The selection text can be queried and changed	363	requested from the server. The selection text can be queried and changed
84	by calling C<< $term->selection >>.	364	by calling C<< $term->selection >>.
85		365
86	Returning a true value aborts selection grabbing. It will still be hilighted.	366	Returning a true value aborts selection grabbing. It will still be hilighted.
87		367
88	=item on_focus_in $term	368	=item on_sel_extend $term
89		369
90	Called whenever the window gets the keyboard focus, before urxvt does	370	Called whenever the user tries to extend the selection (e.g. with a double
91	focus in processing.	371	click) and is either supposed to return false (normal operation), or
		372	should extend the selection itelf and return true to suppress the built-in
		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.
92		376
93	=item on_focus_out $term	377	See the F<selection> example extension.
94
95	Called wheneever the window loses keyboard focus, before urxvt does focus
96	out processing.
97		378
98	=item on_view_change $term, $offset	379	=item on_view_change $term, $offset
99		380
100	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
101	scrolls. Offset C<0> means display the normal terminal, positive values	382	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
109		390
110	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,
111	$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
112	number of lines that will be in the scrollback buffer.	393	number of lines that will be in the scrollback buffer.
113		394
114	=item on_tty_activity $term *NYI*	395	=item on_osc_seq $term, $string
115		396
116	Called whenever the program(s) running in the urxvt window send output.	397	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		398	operating system command) is processed. Cursor position and other state
		399	information is up-to-date when this happens. For interoperability, the
		400	string should start with the extension name and a colon, to distinguish
		401	it from commands for other extensions, and this might be enforced in the
		402	future.
		403
		404	Be careful not ever to trust (in a security sense) the data you receive,
		405	as its source can not easily be controleld (e-mail content, messages from
		406	other users on the same system etc.).
		407
		408	=item on_add_lines $term, $string
		409
		410	Called whenever text is about to be output, with the text as argument. You
		411	can filter/change and output the text yourself by returning a true value
		412	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		413	might be very slow, however, as your hook is called for B<all> text being
		414	output.
		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
		421	=item on_line_update $term, $row
		422
		423	Called whenever a line was updated or changed. Can be used to filter
		424	screen output (e.g. underline urls or other useless stuff). Only lines
		425	that are being shown will be filtered, and, due to performance reasons,
		426	not always immediately.
		427
		428	The row number is always the topmost row of the line if the line spans
		429	multiple rows.
		430
		431	Please note that, if you change the line, then the hook might get called
		432	later with the already-modified line (e.g. if unrelated parts change), so
		433	you cannot just toggle rendition bits, but only set them.
117		434
118	=item on_refresh_begin $term	435	=item on_refresh_begin $term
119		436
120	Called just before the screen gets redrawn. Can be used for overlay	437	Called just before the screen gets redrawn. Can be used for overlay
121	or similar effects by modify terminal contents in refresh_begin, and	438	or similar effects by modify terminal contents in refresh_begin, and
…		…
130		447
131	Called whenever the user presses a key combination that has a	448	Called whenever the user presses a key combination that has a
132	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>
133	resource in the @@RXVT_NAME@@(1) manpage).	450	resource in the @@RXVT_NAME@@(1) manpage).
134		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
		470	=item on_key_press $term, $event, $keysym, $octets
		471
		472	=item on_key_release $term, $event, $keysym
		473
		474	=item on_button_press $term, $event
		475
		476	=item on_button_release $term, $event
		477
		478	=item on_motion_notify $term, $event
		479
		480	=item on_map_notify $term, $event
		481
		482	=item on_unmap_notify $term, $event
		483
		484	Called whenever the corresponding X event is received for the terminal If
		485	the hook returns true, then the even will be ignored by rxvt-unicode.
		486
		487	The event is a hash with most values as named by Xlib (see the XEvent
		488	manpage), with the additional members C<row> and C<col>, which are the row
		489	and column under the mouse cursor.
		490
		491	C<on_key_press> additionally receives the string rxvt-unicode would
		492	output, if any, in locale-specific encoding.
		493
		494	subwindow.
		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
		505	=back
		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
		530	=head2 Variables in the C<urxvt> Package
		531
		532	=over 4
		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
		547	=item $urxvt::TERM
		548
		549	The current terminal. This variable stores the current C<urxvt::term>
		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>.
		567
135	=back	568	=back
136		569
137	=head2 Functions in the C<urxvt> Package	570	=head2 Functions in the C<urxvt> Package
138		571
139	=over 4	572	=over 4
…		…
151	that calls this function.	584	that calls this function.
152		585
153	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
154	correct place, e.g. on stderr of the connecting urxvtc client.	587	correct place, e.g. on stderr of the connecting urxvtc client.
155		588
		589	Messages have a size limit of 1023 bytes currently.
		590
156	=item $time = urxvt::NOW	591	=item $time = urxvt::NOW
157		592
158	Returns the "current time" (as per the event loop).	593	Returns the "current time" (as per the event loop).
159		594
160	=cut	595	=item urxvt::CurrentTime
161		596
162	package urxvt;	597	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		598	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		599	Button4Mask, Button5Mask, AnyModifier
163		600
164	use strict;	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
165		608
166	our $term;	609	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
167	our @HOOKNAME;	610	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
168	our $LIBDIR;	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.
		618
		619	=back
		620
		621	=head2 RENDITION
		622
		623	Rendition bitsets contain information about colour, font, font styles and
		624	similar information for each screen cell.
		625
		626	The following "macros" deal with changes in rendition sets. You should
		627	never just create a bitset, you should always modify an existing one,
		628	as they contain important information required for correct operation of
		629	rxvt-unicode.
		630
		631	=over 4
		632
		633	=item $rend = urxvt::DEFAULT_RSTYLE
		634
		635	Returns the default rendition, as used when the terminal is starting up or
		636	being reset. Useful as a base to start when creating renditions.
		637
		638	=item $rend = urxvt::OVERLAY_RSTYLE
		639
		640	Return the rendition mask used for overlays by default.
		641
		642	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		643
		644	Return the bit that enabled bold, italic, blink, reverse-video and
		645	underline, respectively. To enable such a style, just logically OR it into
		646	the bitset.
		647
		648	=item $foreground = urxvt::GET_BASEFG $rend
		649
		650	=item $background = urxvt::GET_BASEBG $rend
		651
		652	Return the foreground/background colour index, respectively.
		653
		654	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		655
		656	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		657
		658	Replace the foreground/background colour in the rendition mask with the
		659	specified one.
		660
		661	=item $value = urxvt::GET_CUSTOM $rend
		662
		663	Return the "custom" value: Every rendition has 5 bits for use by
		664	extensions. They can be set and changed as you like and are initially
		665	zero.
		666
		667	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		668
		669	Change the custom value.
		670
		671	=back
		672
		673	=cut
169		674
170	BEGIN {	675	BEGIN {
171	urxvt->bootstrap;
172
173	# overwrite perl's warn	676	# overwrite perl's warn
174	*CORE::GLOBAL::warn = sub {	677	*CORE::GLOBAL::warn = sub {
175	my $msg = join "", @_;	678	my $msg = join "", @_;
176	$msg .= "\n"	679	$msg .= "\n"
177	unless $msg =~ /\n$/;	680	unless $msg =~ /\n$/;
178	urxvt::warn ($msg);	681	urxvt::warn ($msg);
179	};	682	};
180	}	683	}
181		684
182	my @hook_count;
183	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	685	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
184		686
185	sub verbose {	687	sub verbose {
186	my ($level, $msg) = @_;	688	my ($level, $msg) = @_;
187	warn "$msg\n" if $level <= $verbosity;	689	warn "$msg\n" if $level <= $verbosity;
188	}	690	}
189		691
190	# find on_xxx subs in the package and register them	692	my %extension_pkg;
191	# as hooks
192	sub register_package($) {
193	my ($pkg) = @_;
194
195	for my $htype (0.. $#HOOKNAME) {
196	my $name = $HOOKNAME[$htype];
197
198	my $ref = $pkg->can ("on_" . lc $name)
199	or next;
200
201	$term->{_hook}[$htype]{$ref*1} = $ref;
202	$hook_count[$htype]++
203	or set_should_invoke $htype, 1;
204	}
205	}
206
207	my $script_pkg = "script0000";
208	my %script_pkg;
209		693
210	# load a single script into its own package, once only	694	# load a single script into its own package, once only
211	sub script_package($) {	695	sub extension_package($) {
212	my ($path) = @_;	696	my ($path) = @_;
213		697
214	$script_pkg{$path} ||= do {	698	$extension_pkg{$path} ||= do {
215	my $pkg = "urxvt::" . ($script_pkg++);	699	$path =~ /([^\/\\]+)$/;
		700	my $pkg = $1;
		701	$pkg =~ s/[^[:word:]]/_/g;
		702	$pkg = "urxvt::ext::$pkg";
216		703
217	verbose 3, "loading script '$path' into package '$pkg'";	704	verbose 3, "loading extension '$path' into package '$pkg'";
218		705
219	open my $fh, "<:raw", $path	706	open my $fh, "<:raw", $path
220	or die "$path: $!";	707	or die "$path: $!";
221		708
		709	my $source =
222	my $source = "package $pkg; use strict; use utf8;\n"	710	"package $pkg; use strict; use utf8;\n"
223	. "#line 1 \"$path\"\n{\n"	711	. "#line 1 \"$path\"\n{\n"
224	. (do { local $/; <$fh> })	712	. (do { local $/; <$fh> })
225	. "\n};\n1";	713	. "\n};\n1";
226		714
		715	eval $source
227	eval $source or die "$path: $@";	716	or die "$path: $@";
228		717
229	$pkg	718	$pkg
230	}	719	}
231	}	720	}
232		721
		722	our $retval; # return value for urxvt
		723
233	# called by the rxvt core	724	# called by the rxvt core
234	sub invoke {	725	sub invoke {
235	local $term = shift;	726	local $TERM = shift;
236	my $htype = shift;	727	my $htype = shift;
237		728
238	if ($htype == 0) { # INIT	729	if ($htype == 0) { # INIT
239	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	730	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		731
		732	my %ext_arg;
240		733
241	for my $ext (split /:/, $term->resource ("perl_ext")) {	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
		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) {
242	my @files = grep -f $_, map "$_/$ext", @dirs;	756	my @files = grep -f $_, map "$_/$ext", @dirs;
243		757
244	if (@files) {	758	if (@files) {
245	register_package script_package $files[0];	759	$TERM->register_package (extension_package $files[0], $argv);
246	} else {	760	} else {
247	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";
248	}	762	}
249	}	763	}
250		764
251	} elsif ($htype == 1) { # DESTROY	765	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
252	if (my $hook = $term->{_hook}) {	766	warn $@ if $@;
253	for my $htype (0..$#$hook) {	767	}
254	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }	768
255	or set_should_invoke $htype, 0;	769	$retval = undef;
		770
		771	if (my $cb = $TERM->{_hook}[$htype]) {
		772	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		773	if $verbosity >= 10;
		774
		775	keys %$cb;
		776
		777	while (my ($pkg, $cb) = each %$cb) {
		778	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
		779	$retval ||= $retval_;
		780
		781	if ($@) {
		782	$TERM->ungrab; # better to lose the grab than the session
		783	warn $@;
256	}	784	}
257	}	785	}
		786
		787	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		788	if $verbosity >= 11;
258	}	789	}
259		790
260	my $cb = $term->{_hook}[$htype]	791	if ($htype == 1) { # DESTROY
261	or return;	792	# clear package objects
		793	%$_ = () for values %{ $TERM->{_pkg} };
262		794
263	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	795	# clear package
264	if $verbosity >= 10;	796	%$TERM = ();
265
266	while (my ($k, $v) = each %$cb) {
267	return 1 if $v->($term, @_);
268	}	797	}
269		798
		799	$retval
		800	}
		801
		802	# urxvt::term::extension
		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;
270	0	819	}
271	}	820	}
272		821
273	=back	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 =~ /:([^:]+)$/
		840	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
		841
		842	eval qq{
		843	sub $AUTOLOAD {
		844	my \$proxy = shift;
		845	\$proxy->{term}->$1 (\@_)
		846	}
		847	1
		848	} or die "FATAL: unable to compile method forwarder: $@";
		849
		850	goto &$AUTOLOAD;
		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;
274		936
275	=head2 The C<urxvt::term> Class	937	=head2 The C<urxvt::term> Class
276		938
277	=over 4	939	=over 4
		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
		988	=item $term->destroy
		989
		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
278		1034
279	=item $value = $term->resource ($name[, $newval])	1035	=item $value = $term->resource ($name[, $newval])
280		1036
281	Returns the current resource value associated with a given name and	1037	Returns the current resource value associated with a given name and
282	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>
…		…
292		1048
293	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
294	terminal is destroyed, so changing options frequently will eat memory.	1050	terminal is destroyed, so changing options frequently will eat memory.
295		1051
296	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
297	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>
298	list:	1054	to see the actual list:
299		1055
300	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1056	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
301	borderLess color cursorBlink cursorUnderline cutchars delete_key	1057	borderLess color cursorBlink cursorUnderline cutchars delete_key
302	display_name embed ext_bwidth fade font geometry hold iconName	1058	display_name embed ext_bwidth fade font geometry hold iconName
303	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1059	imFont imLocale inputMethod insecure int_bwidth intensityStyles
304	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1060	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
305	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	1061	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
306	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1062	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
307	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1063	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
308	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1064	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
309	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1065	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
310	shade term_name title transparent transparent_all tripleclickwords	1066	secondaryScreen secondaryScroll selectstyle shade term_name title
311	utmpInhibit visualBell	1067	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1068	visualBell
312		1069
313	=cut	1070	=cut
314		1071
315	sub urxvt::term::resource($$;$) {	1072	sub resource($$;$) {
316	my ($self, $name) = (shift, shift);	1073	my ($self, $name) = (shift, shift);
317	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1074	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
318	goto &urxvt::term::_resource;	1075	&urxvt::term::_resource
319	}	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.
		1093
		1094	=item $rend = $term->rstyle ([$new_rstyle])
		1095
		1096	Return and optionally change the current rendition. Text that is output by
		1097	the terminal application will use this style.
		1098
		1099	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1100
		1101	Return the current coordinates of the text cursor position and optionally
		1102	set it (which is usually bad as applications don't expect that).
320		1103
321	=item ($row, $col) = $term->selection_mark ([$row, $col])	1104	=item ($row, $col) = $term->selection_mark ([$row, $col])
322		1105
323	=item ($row, $col) = $term->selection_beg ([$row, $col])	1106	=item ($row, $col) = $term->selection_beg ([$row, $col])
324		1107
325	=item ($row, $col) = $term->selection_end ([$row, $col])	1108	=item ($row, $col) = $term->selection_end ([$row, $col])
326		1109
327	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,
328	and optionally set them to new values.	1111	and optionally set them to new values.
329		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
330	=item $success = $term->selection_grab ($eventtime)	1120	=item $success = $term->selection_grab ($eventtime)
331		1121
332	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
333	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.
334		1125
335	=item $oldtext = $term->selection ([$newtext])	1126	=item $oldtext = $term->selection ([$newtext])
336		1127
337	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>.
338		1129
339	=item $term->scr_overlay ($x, $y, $text)	1130	=item $term->overlay_simple ($x, $y, $text)
340		1131
341	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.
342		1133
343	=cut	1134	=cut
344		1135
345	sub urxvt::term::scr_overlay {	1136	sub overlay_simple {
346	my ($self, $x, $y, $text) = @_;	1137	my ($self, $x, $y, $text) = @_;
347		1138
348	my @lines = split /\n/, $text;	1139	my @lines = split /\n/, $text;
349		1140
350	my $w = 0;	1141	my $w = List::Util::max map $self->strwidth ($_), @lines;
351	for (map $self->strwidth ($_), @lines) {
352	$w = $_ if $w < $_;
353	}
354		1142
355	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1143	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
356	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1144	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
357	}
358		1145
		1146	$overlay
		1147	}
		1148
359	=item $term->scr_overlay_new ($x, $y, $width, $height)	1149	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
360		1150
361	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
362	width/height. A border will be put around the box. If either C<$x> or	1152	width/height. C<$rstyle> defines the initial rendition style
363	C<$y> is negative, then this is counted from the right/bottom side,	1153	(default: C<OVERLAY_RSTYLE>).
364	respectively.
365		1154
366	=item $term->scr_overlay_off	1155	If C<$border> is C<2> (default), then a decorative border will be put
		1156	around the box.
367		1157
368	Switch the overlay off again.	1158	If either C<$x> or C<$y> is negative, then this is counted from the
		1159	right/bottom side, respectively.
369		1160
370	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	1161	This method returns an urxvt::overlay object. The overlay will be visible
		1162	as long as the perl object is referenced.
371		1163
372	Put a single character (specified numerically) at the given overlay	1164	The methods currently supported on C<urxvt::overlay> objects are:
373	position.
374		1165
		1166	=over 4
		1167
375	=item $term->scr_overlay_set ($x, $y, $text)	1168	=item $overlay->set ($x, $y, $text, $rend)
376		1169
377	Write a string at the given position into the overlay.	1170	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		1171	text in rxvt-unicode's special encoding and an array of rendition values
		1172	at a specific position inside the overlay.
378		1173
		1174	=item $overlay->hide
		1175
		1176	If visible, hide the overlay, but do not destroy it.
		1177
		1178	=item $overlay->show
		1179
		1180	If hidden, display the overlay again.
		1181
		1182	=back
		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
379	=item $cellwidth = $term->strwidth $string	1211	=item $cellwidth = $term->strwidth ($string)
380		1212
381	Returns the number of screen-cells this string would need. Correctly	1213	Returns the number of screen-cells this string would need. Correctly
382	accounts for wide and combining characters.	1214	accounts for wide and combining characters.
383		1215
384	=item $octets = $term->locale_encode $string	1216	=item $octets = $term->locale_encode ($string)
385		1217
386	Convert the given text string into the corresponding locale encoding.	1218	Convert the given text string into the corresponding locale encoding.
387		1219
388	=item $string = $term->locale_decode $octets	1220	=item $string = $term->locale_decode ($octets)
389		1221
390	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!
		1240
		1241	=item $term->scr_add_lines ($string)
		1242
		1243	Write the given text string to the screen, as if output by the application
		1244	running inside the terminal. It may not contain command sequences (escape
		1245	codes), but is free to use line feeds, carriage returns and tabs. The
		1246	string is a normal text string, not in locale-dependent encoding.
		1247
		1248	Normally its not a good idea to use this function, as programs might be
		1249	confused by changes in cursor position or scrolling. Its useful inside a
		1250	C<on_add_lines> hook, though.
		1251
		1252	=item $term->cmd_parse ($octets)
		1253
		1254	Similar to C<scr_add_lines>, but the argument must be in the
		1255	locale-specific encoding of the terminal and can contain command sequences
		1256	(escape codes) that will be interpreted.
391		1257
392	=item $term->tt_write ($octets)	1258	=item $term->tt_write ($octets)
393		1259
394	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
395	pass characters instead of octets, you should convert your strings first	1261	pass characters instead of octets, you should convert your strings first
396	to the locale-specific encoding using C<< $term->locale_encode >>.	1262	to the locale-specific encoding using C<< $term->locale_encode >>.
397		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
		1271	=item $windowid = $term->parent
		1272
		1273	Return the window id of the toplevel window.
		1274
		1275	=item $windowid = $term->vt
		1276
		1277	Return the window id of the terminal window.
		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
		1286	=item $window_width = $term->width
		1287
		1288	=item $window_height = $term->height
		1289
		1290	=item $font_width = $term->fwidth
		1291
		1292	=item $font_height = $term->fheight
		1293
		1294	=item $font_ascent = $term->fbase
		1295
398	=item $nrow = $term->nrow	1296	=item $terminal_rows = $term->nrow
399		1297
400	=item $ncol = $term->ncol	1298	=item $terminal_columns = $term->ncol
401		1299
402	Return the number of rows/columns of the terminal window (i.e. as	1300	=item $has_focus = $term->focus
403	specified by C<-geometry>, excluding any scrollback).
404		1301
		1302	=item $is_mapped = $term->mapped
		1303
		1304	=item $max_scrollback = $term->saveLines
		1305
		1306	=item $nrow_plus_saveLines = $term->total_rows
		1307
		1308	=item $topmost_scrollback_row = $term->top_row
		1309
		1310	Return various integers describing terminal characteristics.
		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
405	=item $nsaved = $term->nsaved	1320	=item $env = $term->env
406		1321
407	Returns the number of lines in the scrollback buffer.	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.
408		1343
409	=item $view_start = $term->view_start ([$newvalue])	1344	=item $view_start = $term->view_start ([$newvalue])
410		1345
411	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
412	C<0>, which displays the normal terminal contents. Larger values scroll	1347	C<0>, which displays the normal terminal contents. Lower values scroll
413	this many lines into the scrollback buffer.	1348	this many lines into the scrollback buffer.
414		1349
415	=item $term->want_refresh	1350	=item $term->want_refresh
416		1351
417	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1352	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
423	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1358	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
424		1359
425	Returns the text of the entire row with number C<$row_number>. Row C<0>	1360	Returns the text of the entire row with number C<$row_number>. Row C<0>
426	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1361	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
427	terminal line. The scrollback buffer starts at line C<-1> and extends to	1362	terminal line. The scrollback buffer starts at line C<-1> and extends to
428	line C<< -$term->nsaved >>.	1363	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		1364	is requested.
429		1365
430	If C<$new_text> is specified, it will replace characters in the current	1366	If C<$new_text> is specified, it will replace characters in the current
431	line, starting at column C<$start_col> (default C<0>), which is useful	1367	line, starting at column C<$start_col> (default C<0>), which is useful
432	to replace only parts of a line. The font iindex in the rendition will	1368	to replace only parts of a line. The font index in the rendition will
433	automatically be updated.	1369	automatically be updated.
434		1370
435	C<$text> is in a special encoding: tabs and wide characters that use more	1371	C<$text> is in a special encoding: tabs and wide characters that use more
436	than one cell when displayed are padded with urxvt::NOCHAR characters	1372	than one cell when displayed are padded with urxvt::NOCHAR characters
437	(C<chr 65535>). Characters with combining characters and other characters	1373	(C<chr 65535>). Characters with combining characters and other characters
…		…
451	bitsets. Rendition bitsets contain information about colour, font, font	1387	bitsets. Rendition bitsets contain information about colour, font, font
452	styles and similar information. See also C<< $term->ROW_t >>.	1388	styles and similar information. See also C<< $term->ROW_t >>.
453		1389
454	When setting rendition, the font mask will be ignored.	1390	When setting rendition, the font mask will be ignored.
455		1391
456	See the section on RENDITION, below.	1392	See the section on RENDITION, above.
457		1393
458	=item $length = $term->ROW_l ($row_number[, $new_length])	1394	=item $length = $term->ROW_l ($row_number[, $new_length])
459		1395
460	Returns the number of screen cells that are in use ("the line length"). If	1396	Returns the number of screen cells that are in use ("the line
461	it is C<-1>, then the line is part of a multiple-row logical "line", which	1397	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
462	means all characters are in use and it is continued on the next row.	1398	line is joined with the following one.
		1399
		1400	=item $bool = $term->is_longer ($row_number)
		1401
		1402	Returns true if the row is part of a multiple-row logical "line" (i.e.
		1403	joined with the following row), which means all characters are in use
		1404	and it is continued on the next row (and possibly a continuation of the
		1405	previous row(s)).
		1406
		1407	=item $line = $term->line ($row_number)
		1408
		1409	Create and return a new C<urxvt::line> object that stores information
		1410	about the logical line that row C<$row_number> is part of. It supports the
		1411	following methods:
		1412
		1413	=over 4
		1414
		1415	=item $text = $line->t ([$new_text])
		1416
		1417	Returns or replaces the full text of the line, similar to C<ROW_t>
		1418
		1419	=item $rend = $line->r ([$new_rend])
		1420
		1421	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		1422
		1423	=item $length = $line->l
		1424
		1425	Returns the length of the line in cells, similar to C<ROW_l>.
		1426
		1427	=item $rownum = $line->beg
		1428
		1429	=item $rownum = $line->end
		1430
		1431	Return the row number of the first/last row of the line, respectively.
		1432
		1433	=item $offset = $line->offset_of ($row, $col)
		1434
		1435	Returns the character offset of the given row|col pair within the logical
		1436	line. Works for rows outside the line, too, and returns corresponding
		1437	offsets outside the string.
		1438
		1439	=item ($row, $col) = $line->coord_of ($offset)
		1440
		1441	Translates a string offset into terminal coordinates again.
		1442
		1443	=back
		1444
		1445	=cut
		1446
		1447	sub line {
		1448	my ($self, $row) = @_;
		1449
		1450	my $maxrow = $self->nrow - 1;
		1451
		1452	my ($beg, $end) = ($row, $row);
		1453
		1454	--$beg while $self->ROW_is_longer ($beg - 1);
		1455	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1456
		1457	bless {
		1458	term => $self,
		1459	beg => $beg,
		1460	end => $end,
		1461	ncol => $self->ncol,
		1462	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1463	}, urxvt::line::
		1464	}
		1465
		1466	sub urxvt::line::t {
		1467	my ($self) = @_;
		1468
		1469	if (@_ > 1)
		1470	{
		1471	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1472	for $self->{beg} .. $self->{end};
		1473	}
		1474
		1475	defined wantarray &&
		1476	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1477	0, $self->{len}
		1478	}
		1479
		1480	sub urxvt::line::r {
		1481	my ($self) = @_;
		1482
		1483	if (@_ > 1)
		1484	{
		1485	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1486	for $self->{beg} .. $self->{end};
		1487	}
		1488
		1489	if (defined wantarray) {
		1490	my $rend = [
		1491	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1492	];
		1493	$#$rend = $self->{len} - 1;
		1494	return $rend;
		1495	}
		1496
		1497	()
		1498	}
		1499
		1500	sub urxvt::line::beg { $_[0]{beg} }
		1501	sub urxvt::line::end { $_[0]{end} }
		1502	sub urxvt::line::l { $_[0]{len} }
		1503
		1504	sub urxvt::line::offset_of {
		1505	my ($self, $row, $col) = @_;
		1506
		1507	($row - $self->{beg}) * $self->{ncol} + $col
		1508	}
		1509
		1510	sub urxvt::line::coord_of {
		1511	my ($self, $offset) = @_;
		1512
		1513	use integer;
		1514
		1515	(
		1516	$offset / $self->{ncol} + $self->{beg},
		1517	$offset % $self->{ncol}
		1518	)
		1519	}
463		1520
464	=item $text = $term->special_encode $string	1521	=item $text = $term->special_encode $string
465		1522
466	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,
467	where one character corresponds to one screen cell. See	1524	where one character corresponds to one screen cell. See
…		…
470	=item $string = $term->special_decode $text	1527	=item $string = $term->special_decode $text
471		1528
472	Converts rxvt-unicodes text reprsentation into a perl string. See	1529	Converts rxvt-unicodes text reprsentation into a perl string. See
473	C<< $term->ROW_t >> for details.	1530	C<< $term->ROW_t >> for details.
474		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
475	=back	1560	=back
476		1561
477	=head2 RENDITION	1562	=cut
478		1563
479	Rendition bitsets contain information about colour, font, font styles and	1564	package urxvt::popup;
480	similar information for each screen cell.
481		1565
482	The following "macros" deal with changes in rendition sets. You should	1566	=head2 The C<urxvt::popup> Class
483	never just create a bitset, you should always modify an existing one,
484	as they contain important information required for correct operation of
485	rxvt-unicode.
486		1567
487	=over 4	1568	=over 4
488		1569
489	=item $rend = urxvt::DEFAULT_RSTYLE	1570	=cut
490		1571
491	Returns the default rendition, as used when the terminal is starting up or	1572	sub add_item {
492	being reset. Useful as a base	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	}
493		1686
494	=back	1687	=back
495		1688
496	=cut	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__;
497		1697
498	=head2 The C<urxvt::timer> Class	1698	=head2 The C<urxvt::timer> Class
499		1699
500	This class implements timer watchers/events. Time is represented as a	1700	This class implements timer watchers/events. Time is represented as a
501	fractional number of seconds since the epoch. Example:	1701	fractional number of seconds since the epoch. Example:
502		1702
503	# create a digital clock display in upper right corner	1703	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
504	$term->{timer} = urxvt::timer	1704	$term->{timer} = urxvt::timer
505	->new	1705	->new
506	->start (urxvt::NOW)	1706	->interval (1)
507	->cb (sub {	1707	->cb (sub {
508	my ($timer) = @_;
509	my $time = $timer->at;
510	$timer->start ($time + 1);
511	$self->scr_overlay (-1, 0,	1708	$term->{overlay}->set (0, 0,
512	POSIX::strftime "%H:%M:%S", localtime $time);	1709	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
513	});	1710	});
514		1711
515	=over 4	1712	=over 4
516		1713
517	=item $timer = new urxvt::timer	1714	=item $timer = new urxvt::timer
518		1715
519	Create a new timer object in stopped state.	1716	Create a new timer object in started state. It is scheduled to fire
		1717	immediately.
520		1718
521	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1719	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
522		1720
523	Set the callback to be called when the timer triggers.	1721	Set the callback to be called when the timer triggers.
524		1722
…		…
528		1726
529	=item $timer = $timer->set ($tstamp)	1727	=item $timer = $timer->set ($tstamp)
530		1728
531	Set the time the event is generated to $tstamp.	1729	Set the time the event is generated to $tstamp.
532		1730
		1731	=item $timer = $timer->interval ($interval)
		1732
		1733	Normally (and when C<$interval> is C<0>), the timer will automatically
		1734	stop after it has fired once. If C<$interval> is non-zero, then the timer
		1735	is automatically rescheduled at the given intervals.
		1736
533	=item $timer = $timer->start	1737	=item $timer = $timer->start
534		1738
535	Start the timer.	1739	Start the timer.
536		1740
537	=item $timer = $timer->start ($tstamp)	1741	=item $timer = $timer->start ($tstamp)
538		1742
539	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.
		1744
		1745	=item $timer = $timer->after ($delay)
		1746
		1747	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
540		1748
541	=item $timer = $timer->stop	1749	=item $timer = $timer->stop
542		1750
543	Stop the timer.	1751	Stop the timer.
544		1752
…		…
550		1758
551	$term->{socket} = ...	1759	$term->{socket} = ...
552	$term->{iow} = urxvt::iow	1760	$term->{iow} = urxvt::iow
553	->new	1761	->new
554	->fd (fileno $term->{socket})	1762	->fd (fileno $term->{socket})
555	->events (1) # wait for read data	1763	->events (urxvt::EVENT_READ)
556	->start	1764	->start
557	->cb (sub {	1765	->cb (sub {
558	my ($iow, $revents) = @_;	1766	my ($iow, $revents) = @_;
559	# $revents must be 1 here, no need to check	1767	# $revents must be 1 here, no need to check
560	sysread $term->{socket}, my $buf, 8192	1768	sysread $term->{socket}, my $buf, 8192
…		…
577		1785
578	Set the filedescriptor (not handle) to watch.	1786	Set the filedescriptor (not handle) to watch.
579		1787
580	=item $iow = $iow->events ($eventmask)	1788	=item $iow = $iow->events ($eventmask)
581		1789
582	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
583	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>.
584		1793
585	=item $iow = $iow->start	1794	=item $iow = $iow->start
586		1795
587	Start watching for requested events on the given handle.	1796	Start watching for requested events on the given handle.
588		1797
589	=item $iow = $iow->stop	1798	=item $iow = $iow->stop
590		1799
591	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.
592		1862
593	=back	1863	=back
594		1864
595	=head1 ENVIRONMENT	1865	=head1 ENVIRONMENT
596		1866
…		…
599	This variable controls the verbosity level of the perl extension. Higher	1869	This variable controls the verbosity level of the perl extension. Higher
600	numbers indicate more verbose output.	1870	numbers indicate more verbose output.
601		1871
602	=over 4	1872	=over 4
603		1873
604	=item 0 - only fatal messages	1874	=item == 0 - fatal messages
605		1875
606	=item 3 - script loading and management	1876	=item >= 3 - script loading and management
607		1877
608	=item 10 - all events received	1878	=item >=10 - all called hooks
		1879
		1880	=item >=11 - hook reutrn values
609		1881
610	=back	1882	=back
611		1883
612	=head1 AUTHOR	1884	=head1 AUTHOR
613		1885

Diff Legend

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