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.50 by root, Sun Jan 8 00:11:38 2006 UTC vs.
Revision 1.130 by root, Wed Jan 25 15:32:48 2006 UTC

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

Diff Legend

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