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

Diff Legend

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