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.97 by elmex, Tue Jan 17 16:53:47 2006 UTC vs.
Revision 1.223 by root, Sat Jul 14 08:00:18 2012 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed
		38	using F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	@@RXVT_NAME@@ -pe <extensionname>
39		43
40	=over 4	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	=item selection (enabled by default)	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	Extensions that add command line parameters or resources on their own are
45	when the user extends selections (double-click and further clicks). Right	49	loaded automatically when used.
46	now, it tries to select words, urls and complete shell-quoted
47	arguments, which is very convenient, too, if your F<ls> supports
48	C<--quoting-style=shell>.
49
50	A double-click usually selects the word under the cursor, further clicks
51	will enlarge the selection.
52
53	The selection works by trying to match a number of regexes and displaying
54	them in increasing order of length. You can add your own regexes by
55	specifying resources of the form:
56
57	URxvt.selection.pattern-0: perl-regex
58	URxvt.selection.pattern-1: perl-regex
59	...
60
61	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:
65
66	URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.
70
71	This extension also offers following bindable keyboard commands:
72
73	=over 4
74
75	=item rot13
76
77	Rot-13 the selection when activated. Used via keyboard trigger:
78
79	URxvt.keysym.C-M-r: perl:selection:rot13
80
81	=back
82
83	=item option-popup (enabled by default)
84
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.
87
88	=item selection-popup (enabled by default)
89
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.
93
94	=item searchable-scrollback<hotkey> (enabled by default)
95
96	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
98	input/output is suspended and a regex is displayed at the bottom of the
99	screen.
100
101	Inputting characters appends them to the regex and continues incremental
102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
104	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary
107	selection.
108
109	=item selection-autotransform
110
111	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.
113
114	It works by specifying perl snippets (most useful is a single C<s///>
115	operator) that modify C<$_> as resources:
116
117	URxvt.selection-autotransform.0: transform
118	URxvt.selection-autotransform.1: transform
119	...
120
121	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:
124
125	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:
129
130	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132	Of course, this can be modified to suit your needs and your editor :)
133
134	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:
136
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
139
140	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.
143
144	=item mark-urls
145
146	Uses per-line display filtering (C<on_line_update>) to underline urls and
147	make them clickable. When middle-clicked, the program specified in the
148	resource C<urlLauncher> (default C<x-www-browser>) will be started with
149	the URL as first argument.
150
151	=item block-graphics-to-ascii
152
153	A not very useful example of filtering all text output to the terminal,
154	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.
156
157	=item digital-clock
158
159	Displays a digital clock using the built-in overlay.
160
161	=item example-refresh-hooks
162
163	Displays a very simple digital clock in the upper right corner of the
164	window. Illustrates overwriting the refresh callbacks to create your own
165	overlays or changes.
166
167	=item selection-pastebin
168
169	Uploads the selection as textfile to a remote site.
170
171	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
172
173	To set the command to upload the file set this resource:
174
175	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
176
177	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
178	md5 sum of the selection.
179	After an successful upload the selection will be replaced by the following url
180	(the % is the placeholder for the filename):
181
182	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
183
184	=back
185		50
186	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
187		52
188	=head2 General API Considerations	53	=head2 General API Considerations
189		54
…		…
203		68
204	=over 4	69	=over 4
205		70
206	=item $text	71	=item $text
207		72
208	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
209	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
210		75
211	=item $string	76	=item $string
212		77
213	A perl text string, with an emphasis on I<text>. It can store all unicode	78	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
217	=item $octets	82	=item $octets
218		83
219	Either binary data or - more common - a text string encoded in a	84	Either binary data or - more common - a text string encoded in a
220	locale-specific way.	85	locale-specific way.
221		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
222	=back	93	=back
223		94
224	=head2 Extension Objects	95	=head2 Extension Objects
225		96
226	Very perl extension is a perl class. A separate perl object is created	97	Every perl extension is a perl class. A separate perl object is created
227	for each terminal and each extension and passed as the first parameter to	98	for each terminal, and each terminal has its own set of extension objects,
228	hooks. So extensions can use their C<$self> object without having to think	99	which are passed as the first parameter to hooks. So extensions can use
229	about other extensions, with the exception of methods and members that	100	their C<$self> object without having to think about clashes with other
		101	extensions or other terminals, with the exception of methods and members
230	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
231	use.	103	internal use.
232		104
233	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
234	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
235		107
236	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
237		109	the C<urxvt::extension> section below.
238	=over 4
239
240	=item $urxvt_term = $self->{term}
241
242	Returns the C<urxvt::term> object associated with this instance of the
243	extension. This member I<must not> be changed in any way.
244
245	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
246
247	Dynamically enable the given hooks (named without the C<on_> prefix) for
248	this extension, replacing any previous hook. This is useful when you want
249	to overwrite time-critical hooks only temporarily.
250
251	=item $self->disable ($hook_name[, $hook_name..])
252
253	Dynamically disable the given hooks.
254
255	=back
256		110
257	=head2 Hooks	111	=head2 Hooks
258		112
259	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
260	called whenever the relevant event happens.	114	called whenever the relevant event happens.
261		115
262	The first argument passed to them is an extension oject as described in	116	The first argument passed to them is an extension object as described in
263	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
264		118
265	B<All> of these hooks must return a boolean value. If it is true, then the	119	B<All> of these hooks must return a boolean value. If any of the called
266	event counts as being I<consumed>, and the invocation of other hooks is	120	hooks returns true, then the event counts as being I<consumed>, and the
267	skipped, and the relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
268		122
269	I<< When in doubt, return a false value (preferably C<()>). >>	123	I<< When in doubt, return a false value (preferably C<()>). >>
270		124
271	=over 4	125	=over 4
272		126
273	=item on_init $term	127	=item on_init $term
274		128
275	Called after a new terminal object has been initialized, but before	129	Called after a new terminal object has been initialized, but before
276	windows are created or the command gets run. Most methods are unsafe to	130	windows are created or the command gets run. Most methods are unsafe to
277	call or deliver senseless data, as terminal size and other characteristics	131	call or deliver senseless data, as terminal size and other characteristics
278	have not yet been determined. You can safely query and change resources,	132	have not yet been determined. You can safely query and change resources
279	though.	133	and options, though. For many purposes the C<on_start> hook is a better
		134	place.
		135
		136	=item on_start $term
		137
		138	Called at the very end of initialisation of a new terminal, just before
		139	trying to map (display) the toplevel and returning to the main loop.
		140
		141	=item on_destroy $term
		142
		143	Called whenever something tries to destroy terminal, when the terminal is
		144	still fully functional (not for long, though).
280		145
281	=item on_reset $term	146	=item on_reset $term
282		147
283	Called after the screen is "reset" for any reason, such as resizing or	148	Called after the screen is "reset" for any reason, such as resizing or
284	control sequences. Here is where you can react on changes to size-related	149	control sequences. Here is where you can react on changes to size-related
285	variables.	150	variables.
286		151
287	=item on_start $term	152	=item on_child_start $term, $pid
288		153
289	Called at the very end of initialisation of a new terminal, just before	154	Called just after the child process has been C<fork>ed.
290	returning to the mainloop.	155
		156	=item on_child_exit $term, $status
		157
		158	Called just after the child process has exited. C<$status> is the status
		159	from C<waitpid>.
291		160
292	=item on_sel_make $term, $eventtime	161	=item on_sel_make $term, $eventtime
293		162
294	Called whenever a selection has been made by the user, but before the	163	Called whenever a selection has been made by the user, but before the
295	selection text is copied, so changes to the beginning, end or type of the	164	selection text is copied, so changes to the beginning, end or type of the
…		…
302		171
303	Called whenever a selection has been copied, but before the selection is	172	Called whenever a selection has been copied, but before the selection is
304	requested from the server. The selection text can be queried and changed	173	requested from the server. The selection text can be queried and changed
305	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
306		175
307	Returning a true value aborts selection grabbing. It will still be hilighted.	176	Returning a true value aborts selection grabbing. It will still be highlighted.
308		177
309	=item on_sel_extend $term	178	=item on_sel_extend $term
310		179
311	Called whenever the user tries to extend the selection (e.g. with a double	180	Called whenever the user tries to extend the selection (e.g. with a double
312	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
313	should extend the selection itelf and return true to suppress the built-in	182	should extend the selection itself and return true to suppress the built-in
314	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
315	returns true, it will be called on every further click by the user and is	184	returns true, it will be called on every further click by the user and is
316	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
317		186
318	See the F<selection> example extension.	187	See the F<selection> example extension.
319		188
320	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
321		190
322	Called whenever the view offset changes, i..e the user or program	191	Called whenever the view offset changes, i.e. the user or program
323	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
324	show this many lines of scrollback.	193	show this many lines of scrollback.
325		194
326	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
327		196
…		…
331		200
332	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
333	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
334	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
335		204
336	=item on_osc_seq $term, $string	205	=item on_osc_seq $term, $op, $args, $resp
		206
		207	Called on every OSC sequence and can be used to suppress it or modify its
		208	behaviour. The default should be to return an empty list. A true value
		209	suppresses execution of the request completely. Make sure you don't get
		210	confused by recursive invocations when you output an OSC sequence within
		211	this callback.
		212
		213	C<on_osc_seq_perl> should be used for new behaviour.
		214
		215	=item on_osc_seq_perl $term, $args, $resp
337		216
338	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
339	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
340	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
341	string should start with the extension name and a colon, to distinguish	220	string should start with the extension name (sans -osc) and a semicolon,
342	it from commands for other extensions, and this might be enforced in the	221	to distinguish it from commands for other extensions, and this might be
343	future.	222	enforced in the future.
		223
		224	For example, C<overlay-osc> uses this:
		225
		226	sub on_osc_seq_perl {
		227	my ($self, $osc, $resp) = @_;
		228
		229	return unless $osc =~ s/^overlay;//;
		230
		231	... process remaining $osc string
		232	}
344		233
345	Be careful not ever to trust (in a security sense) the data you receive,	234	Be careful not ever to trust (in a security sense) the data you receive,
346	as its source can not easily be controleld (e-mail content, messages from	235	as its source can not easily be controlled (e-mail content, messages from
347	other users on the same system etc.).	236	other users on the same system etc.).
		237
		238	For responses, C<$resp> contains the end-of-args separator used by the
		239	sender.
348		240
349	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
350		242
351	Called whenever text is about to be output, with the text as argument. You	243	Called whenever text is about to be output, with the text as argument. You
352	can filter/change and output the text yourself by returning a true value	244	can filter/change and output the text yourself by returning a true value
…		…
357	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
358		250
359	Called whenever some data is written to the tty/pty and can be used to	251	Called whenever some data is written to the tty/pty and can be used to
360	suppress or filter tty input.	252	suppress or filter tty input.
361		253
		254	=item on_tt_paste $term, $octets
		255
		256	Called whenever text is about to be pasted, with the text as argument. You
		257	can filter/change and paste the text yourself by returning a true value
		258	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		259	locale-encoded.
		260
362	=item on_line_update $term, $row	261	=item on_line_update $term, $row
363		262
364	Called whenever a line was updated or changed. Can be used to filter	263	Called whenever a line was updated or changed. Can be used to filter
365	screen output (e.g. underline urls or other useless stuff). Only lines	264	screen output (e.g. underline urls or other useless stuff). Only lines
366	that are being shown will be filtered, and, due to performance reasons,	265	that are being shown will be filtered, and, due to performance reasons,
…		…
373	later with the already-modified line (e.g. if unrelated parts change), so	272	later with the already-modified line (e.g. if unrelated parts change), so
374	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
375		274
376	=item on_refresh_begin $term	275	=item on_refresh_begin $term
377		276
378	Called just before the screen gets redrawn. Can be used for overlay	277	Called just before the screen gets redrawn. Can be used for overlay or
379	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
380	restoring them in refresh_end. The built-in overlay and selection display	279	restoring them in refresh_end. The built-in overlay and selection display
381	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
382		281
383	=item on_refresh_end $term	282	=item on_refresh_end $term
384		283
385	Called just after the screen gets redrawn. See C<on_refresh_begin>.	284	Called just after the screen gets redrawn. See C<on_refresh_begin>.
386		285
387	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string
388		287
389	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
390	C<perl:string> action bound to it (see description of the B<keysym>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
391	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the @@RXVT_NAME@@(1) manpage).
		291
		292	The event is simply the action string. This interface is assumed to change
		293	slightly in the future.
		294
		295	=item on_register_command $term, $keysym, $modifiermask, $string
		296
		297	Called after parsing a keysym resource but before registering the
		298	associated binding. If this hook returns TRUE the binding is not
		299	registered. It can be used to modify a binding by calling
		300	C<register_command>.
		301
		302	=item on_resize_all_windows $term, $new_width, $new_height
		303
		304	Called just after the new window size has been calculated, but before
		305	windows are actually being resized or hints are being set. If this hook
		306	returns TRUE, setting of the window hints is being skipped.
392		307
393	=item on_x_event $term, $event	308	=item on_x_event $term, $event
394		309
395	Called on every X event received on the vt window (and possibly other	310	Called on every X event received on the vt window (and possibly other
396	windows). Should only be used as a last resort. Most event structure	311	windows). Should only be used as a last resort. Most event structure
397	members are not passed.	312	members are not passed.
398		313
		314	=item on_root_event $term, $event
		315
		316	Like C<on_x_event>, but is called for events on the root window.
		317
399	=item on_focus_in $term	318	=item on_focus_in $term
400		319
401	Called whenever the window gets the keyboard focus, before rxvt-unicode	320	Called whenever the window gets the keyboard focus, before rxvt-unicode
402	does focus in processing.	321	does focus in processing.
403		322
404	=item on_focus_out $term	323	=item on_focus_out $term
405		324
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	325	Called whenever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	326	focus out processing.
408		327
		328	=item on_configure_notify $term, $event
		329
		330	=item on_property_notify $term, $event
		331
409	=item on_key_press $term, $event, $keysym, $octets	332	=item on_key_press $term, $event, $keysym, $octets
410		333
411	=item on_key_release $term, $event, $keysym	334	=item on_key_release $term, $event, $keysym
412		335
413	=item on_button_press $term, $event	336	=item on_button_press $term, $event
…		…
418		341
419	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
420		343
421	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
422		345
423	Called whenever the corresponding X event is received for the terminal If	346	Called whenever the corresponding X event is received for the terminal. If
424	the hook returns true, then the even will be ignored by rxvt-unicode.	347	the hook returns true, then the event will be ignored by rxvt-unicode.
425		348
426	The event is a hash with most values as named by Xlib (see the XEvent	349	The event is a hash with most values as named by Xlib (see the XEvent
427	manpage), with the additional members C<row> and C<col>, which are the row	350	manpage), with the additional members C<row> and C<col>, which are the
428	and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
429		352
430	C<on_key_press> additionally receives the string rxvt-unicode would	353	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	354	output, if any, in locale-specific encoding.
432		355
433	subwindow.	356	subwindow.
434		357
		358	=item on_client_message $term, $event
		359
		360	=item on_wm_protocols $term, $event
		361
		362	=item on_wm_delete_window $term, $event
		363
		364	Called when various types of ClientMessage events are received (all with
		365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
435	=back	371	=back
436		372
437	=cut	373	=cut
438		374
439	package urxvt;	375	package urxvt;
440		376
441	use utf8;	377	use utf8;
442	use strict;	378	use strict 'vars';
443	use Carp ();	379	use Carp ();
444	use Scalar::Util ();	380	use Scalar::Util ();
445	use List::Util ();	381	use List::Util ();
446		382
447	our $VERSION = 1;	383	our $VERSION = 1;
448	our $TERM;	384	our $TERM;
		385	our @TERM_INIT; # should go, prevents async I/O etc.
		386	our @TERM_EXT; # should go, prevents async I/O etc.
449	our @HOOKNAME;	387	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	389	our %OPTION;
452		390
453	our $LIBDIR;	391	our $LIBDIR;
454	our $RESNAME;	392	our $RESNAME;
455	our $RESCLASS;	393	our $RESCLASS;
456	our $RXVTNAME;	394	our $RXVTNAME;
457		395
		396	our $NOCHAR = chr 0xffff;
		397
458	=head2 Variables in the C<urxvt> Package	398	=head2 Variables in the C<urxvt> Package
459		399
460	=over 4	400	=over 4
461		401
462	=item $urxvt::LIBDIR	402	=item $urxvt::LIBDIR
…		…
475	=item $urxvt::TERM	415	=item $urxvt::TERM
476		416
477	The current terminal. This variable stores the current C<urxvt::term>	417	The current terminal. This variable stores the current C<urxvt::term>
478	object, whenever a callback/hook is executing.	418	object, whenever a callback/hook is executing.
479		419
		420	=item @urxvt::TERM_INIT
		421
		422	All code references in this array will be called as methods of the next newly
		423	created C<urxvt::term> object (during the C<on_init> phase). The array
		424	gets cleared before the code references that were in it are being executed,
		425	so references can push themselves onto it again if they so desire.
		426
		427	This complements to the perl-eval command line option, but gets executed
		428	first.
		429
		430	=item @urxvt::TERM_EXT
		431
		432	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		433	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		434	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		435
480	=back	436	=back
481		437
482	=head2 Functions in the C<urxvt> Package	438	=head2 Functions in the C<urxvt> Package
483		439
484	=over 4	440	=over 4
485		441
486	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
487		443
488	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
489	costs! The only time this is acceptable is when the terminal process	445	include a trailing newline). Avoid at all costs! The only time this
490	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
491		448
492	=item urxvt::warn $string	449	=item urxvt::warn $string
493		450
494	Calls C<rxvt_warn> with the given string which should not include a	451	Calls C<rxvt_warn> with the given string which should include a trailing
495	newline. The module also overwrites the C<warn> builtin with a function	452	newline. The module also overwrites the C<warn> builtin with a function
496	that calls this function.	453	that calls this function.
497		454
498	Using this function has the advantage that its output ends up in the	455	Using this function has the advantage that its output ends up in the
499	correct place, e.g. on stderr of the connecting urxvtc client.	456	correct place, e.g. on stderr of the connecting urxvtc client.
500		457
501	Messages have a size limit of 1023 bytes currently.	458	Messages have a size limit of 1023 bytes currently.
		459
		460	=item @terms = urxvt::termlist
		461
		462	Returns all urxvt::term objects that exist in this process, regardless of
		463	whether they are started, being destroyed etc., so be careful. Only term
		464	objects that have perl extensions attached will be returned (because there
		465	is no urxvt::term object associated with others).
502		466
503	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
504		468
505	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
506		470
…		…
549		513
550	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
551		515
552	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
553		517
554	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	518	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		519	urxvt::RS_RVid, urxvt::RS_Uline
555		520
556	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
557	underline, respectively. To enable such a style, just logically OR it into	522	underline, respectively. To enable such a style, just logically OR it into
558	the bitset.	523	the bitset.
559		524
…		…
565		530
566	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	531	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
567		532
568	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	533	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
569		534
		535	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		536
570	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
571	specified one.	538	specified one.
572		539
573	=item $value = urxvt::GET_CUSTOM $rend	540	=item $value = urxvt::GET_CUSTOM $rend
574		541
…		…
583	=back	550	=back
584		551
585	=cut	552	=cut
586		553
587	BEGIN {	554	BEGIN {
588	urxvt->bootstrap;
589
590	# overwrite perl's warn	555	# overwrite perl's warn
591	*CORE::GLOBAL::warn = sub {	556	*CORE::GLOBAL::warn = sub {
592	my $msg = join "", @_;	557	my $msg = join "", @_;
593	$msg .= "\n"	558	$msg .= "\n"
594	unless $msg =~ /\n$/;	559	unless $msg =~ /\n$/;
595	urxvt::warn ($msg);	560	urxvt::warn ($msg);
596	};	561	};
		562	}
597		563
598	# %ENV is the original startup environment	564	no warnings 'utf8';
599	delete $ENV{IFS};	565
600	delete $ENV{CDPATH};	566	sub parse_resource {
601	delete $ENV{BASH_ENV};	567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
602	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	568
		569	$name =~ y/-/./ if $isarg;
		570
		571	$term->scan_meta;
		572
		573	my $r = $term->{meta}{resource};
		574	keys %$r; # reste iterator
		575	while (my ($pattern, $v) = each %$r) {
		576	if (
		577	$pattern =~ /\.$/
		578	? $pattern eq substr $name, 0, length $pattern
		579	: $pattern eq $name
		580	) {
		581	$name = "$urxvt::RESCLASS.$name";
		582
		583	push @{ $term->{perl_ext_3} }, $v->[0];
		584
		585	if ($v->[1] eq "boolean") {
		586	$term->put_option_db ($name, $flag ? "true" : "false");
		587	return 1;
		588	} else {
		589	$term->put_option_db ($name, $value);
		590	return 1 + 2;
		591	}
		592	}
		593	}
		594
		595	0
		596	}
		597
		598	sub usage {
		599	my ($term, $usage_type) = @_;
		600
		601	$term->scan_meta;
		602
		603	my $r = $term->{meta}{resource};
		604
		605	for my $pattern (sort keys %$r) {
		606	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		607
		608	$desc .= " (-pe $ext)";
		609
		610	if ($usage_type == 1) {
		611	$pattern =~ y/./-/;
		612	$pattern =~ s/-$/-.../g;
		613
		614	if ($type eq "boolean") {
		615	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		616	} else {
		617	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		618	}
		619	} else {
		620	$pattern =~ s/\.$/.*/g;
		621	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		622	}
		623	}
603	}	624	}
604		625
605	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
606		627
607	sub verbose {	628	sub verbose {
608	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
609	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
610	}	631	}
611		632
612	my $extension_pkg = "extension0000";
613	my %extension_pkg;	633	my %extension_pkg;
614		634
615	# load a single script into its own package, once only	635	# load a single script into its own package, once only
616	sub extension_package($) {	636	sub extension_package($) {
617	my ($path) = @_;	637	my ($path) = @_;
618		638
619	$extension_pkg{$path} ||= do {	639	$extension_pkg{$path} ||= do {
620	my $pkg = "urxvt::" . ($extension_pkg++);	640	$path =~ /([^\/\\]+)$/;
		641	my $pkg = $1;
		642	$pkg =~ s/[^[:word:]]/_/g;
		643	$pkg = "urxvt::ext::$pkg";
621		644
622	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
623		648
624	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
625	or die "$path: $!";	650	or die "$path: $!";
626		651
627	my $source =	652	my $source =
628	"package $pkg; use strict; use utf8;\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
629	. "use base urxvt::term::extension::;\n"
630	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
631	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
632	. "\n};\n1";	656	. "\n};\n1";
633		657
634	eval $source	658	eval $source
…		…
644	sub invoke {	668	sub invoke {
645	local $TERM = shift;	669	local $TERM = shift;
646	my $htype = shift;	670	my $htype = shift;
647		671
648	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
649	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
650		674
651	my %ext_arg;	675	my %ext_arg;
652		676
		677	{
		678	my @init = @TERM_INIT;
		679	@TERM_INIT = ();
		680	$_->($TERM) for @init;
		681	my @pkg = @TERM_EXT;
		682	@TERM_EXT = ();
		683	$TERM->register_package ($_) for @pkg;
		684	}
		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
653	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
654	if ($_ eq "default") {	690	if ($_ eq "default") {
655	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	691	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
656	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
657	delete $ext_arg{$1};	693	delete $ext_arg{$1};
658	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
659	push @{ $ext_arg{$1} }, $2;	695	push @{ $ext_arg{$1} }, $2;
660	} else {	696	} else {
661	$ext_arg{$_} ||= [];	697	$ext_arg{$_} ||= [];
662	}	698	}
663	}	699	}
664		700
665	while (my ($ext, $argv) = each %ext_arg) {	701	for my $ext (sort keys %ext_arg) {
666	my @files = grep -f $_, map "$_/$ext", @dirs;	702	my @files = grep -f $_, map "$_/$ext", @dirs;
667		703
668	if (@files) {	704	if (@files) {
669	$TERM->register_package (extension_package $files[0], $argv);	705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
670	} else {	706	} else {
671	warn "perl extension '$ext' not found in perl library search path\n";	707	warn "perl extension '$ext' not found in perl library search path\n";
672	}	708	}
673	}	709	}
674		710
…		…
680		716
681	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
682	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
683	if $verbosity >= 10;	719	if $verbosity >= 10;
684		720
685	keys %$cb;	721	for my $pkg (keys %$cb) {
686
687	while (my ($pkg, $cb) = each %$cb) {
688	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
689	and last;	723	$retval ||= $retval_;
690		724
691	if ($@) {	725	if ($@) {
692	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
693	warn $@;	727	warn $@;
694	}	728	}
…		…
707	}	741	}
708		742
709	$retval	743	$retval
710	}	744	}
711		745
712	sub exec_async(@) {	746	sub SET_COLOR($$$) {
713	my $pid = fork;	747	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
714
715	return
716	if !defined $pid or $pid;
717
718	%ENV = %{ $TERM->env };
719
720	exec @_;
721	_exit 255;
722	}	748	}
723		749
724	# urxvt::term::extension	750	sub rend2mask {
		751	no strict 'refs';
		752	my ($str, $mask) = (@_, 0);
		753	my %color = ( fg => undef, bg => undef );
		754	my @failed;
		755	for my $spec ( split /\s+/, $str ) {
		756	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		757	$color{lc($1)} = $2;
		758	} else {
		759	my $neg = $spec =~ s/^[-^]//;
		760	unless ( exists &{"RS_$spec"} ) {
		761	push @failed, $spec;
		762	next;
		763	}
		764	my $cur = &{"RS_$spec"};
		765	if ( $neg ) {
		766	$mask &= ~$cur;
		767	} else {
		768	$mask |= $cur;
		769	}
		770	}
		771	}
		772	($mask, @color{qw(fg bg)}, \@failed)
		773	}
725		774
726	package urxvt::term::extension;	775	package urxvt::term::extension;
727		776
728	sub enable {	777	=head2 The C<urxvt::term::extension> class
729	my ($self, %hook) = @_;
730	my $pkg = $self->{_pkg};
731		778
732	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
733	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
734	defined $htype
735	or Carp::croak "unsupported hook type '$name'";
736		781
737	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
738	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
739		784
740	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
741	}	786	objects, in addition to call methods documented for the <urxvt::term>
742	}	787	class.
743		788
744	sub disable {	789	=over 4
745	my ($self, @hook) = @_;
746	my $pkg = $self->{_pkg};
747		790
748	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
749	my $htype = $HOOKTYPE{uc $name};
750	defined $htype
751	or Carp::croak "unsupported hook type '$name'";
752		792
753	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
754	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
755	}	795
756	}	796	=cut
757		797
758	our $AUTOLOAD;	798	our $AUTOLOAD;
759		799
760	sub AUTOLOAD {	800	sub AUTOLOAD {
761	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
774		814
775	sub DESTROY {	815	sub DESTROY {
776	# nop	816	# nop
777	}	817	}
778		818
779	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
780		820
781	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
782	${$_[0]}->();	822	${$_[0]}->();
783	}	823	}
784		824
785	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
786	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
787	}	827	}
		828
		829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		830
		831	Dynamically enable the given hooks (named without the C<on_> prefix) for
		832	this extension, replacing any previous hook. This is useful when you want
		833	to overwrite time-critical hooks only temporarily.
		834
		835	To install additional callbacks for the same hook, you can use the C<on>
		836	method of the C<urxvt::term> class.
		837
		838	=item $self->disable ($hook_name[, $hook_name..])
		839
		840	Dynamically disable the given hooks.
		841
		842	=cut
		843
		844	sub enable {
		845	my ($self, %hook) = @_;
		846	my $pkg = $self->{_pkg};
		847
		848	while (my ($name, $cb) = each %hook) {
		849	my $htype = $HOOKTYPE{uc $name};
		850	defined $htype
		851	or Carp::croak "unsupported hook type '$name'";
		852
		853	$self->set_should_invoke ($htype, +1)
		854	unless exists $self->{term}{_hook}[$htype]{$pkg};
		855
		856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		857	}
		858	}
		859
		860	sub disable {
		861	my ($self, @hook) = @_;
		862	my $pkg = $self->{_pkg};
		863
		864	for my $name (@hook) {
		865	my $htype = $HOOKTYPE{uc $name};
		866	defined $htype
		867	or Carp::croak "unsupported hook type '$name'";
		868
		869	$self->set_should_invoke ($htype, -1)
		870	if delete $self->{term}{_hook}[$htype]{$pkg};
		871	}
		872	}
		873
		874	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		875
		876	Similar to the C<enable> enable, but installs additional callbacks for
		877	the given hook(s) (that is, it doesn't replace existing callbacks), and
		878	returns a guard object. When the guard object is destroyed the callbacks
		879	are disabled again.
		880
		881	=cut
		882
		883	sub urxvt::extension::on_disable::DESTROY {
		884	my $disable = shift;
		885
		886	my $term = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	warn "disable hook $htype,$id\n";#d#
		890	delete $term->{_hook}[$htype]{$id};
		891	$term->set_should_invoke ($htype, -1);
		892	}
		893	}
		894
		895	sub on {
		896	my ($self, %hook) = @_;
		897
		898	my $term = $self->{term};
		899
		900	my %disable = ( "" => $term );
		901
		902	while (my ($name, $cb) = each %hook) {
		903	my $htype = $HOOKTYPE{uc $name};
		904	defined $htype
		905	or Carp::croak "unsupported hook type '$name'";
		906
		907	$term->set_should_invoke ($htype, +1);
		908	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		909	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		910	}
		911
		912	bless \%disable, "urxvt::extension::on_disable"
		913	}
		914
		915	=item $self->x_resource ($pattern)
		916
		917	=item $self->x_resource_boolean ($pattern)
		918
		919	These methods support an additional C<%> prefix when called on an
		920	extension object - see the description of these methods in the
		921	C<urxvt::term> class for details.
		922
		923	=cut
		924
		925	sub x_resource {
		926	my ($self, $name) = @_;
		927	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		928	$self->{term}->x_resource ($name)
		929	}
		930
		931	sub x_resource_boolean {
		932	my ($self, $name) = @_;
		933	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		934	$self->{term}->x_resource_boolean ($name)
		935	}
		936
		937	=back
		938
		939	=cut
788		940
789	package urxvt::anyevent;	941	package urxvt::anyevent;
790		942
791	=head2 The C<urxvt::anyevent> Class	943	=head2 The C<urxvt::anyevent> Class
792		944
793	The sole purpose of this class is to deliver an interface to the	945	The sole purpose of this class is to deliver an interface to the
794	C<AnyEvent> module - any module using it will work inside urxvt without	946	C<AnyEvent> module - any module using it will work inside urxvt without
795	further programming. The only exception is that you cannot wait on	947	further programming. The only exception is that you cannot wait on
796	condition variables, but non-blocking condvar use is ok. What this means	948	condition variables, but non-blocking condvar use is ok.
797	is that you cannot use blocking APIs, but the non-blocking variant should
798	work.
799		949
800	=cut	950	In practical terms this means is that you cannot use blocking APIs, but
		951	the non-blocking variant should work.
801		952
		953	=cut
		954
802	our $VERSION = 1;	955	our $VERSION = '5.23';
803		956
804	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	957	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
805	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	958	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
806		959
807	sub timer {	960	sub timer {
…		…
809		962
810	my $cb = $arg{cb};	963	my $cb = $arg{cb};
811		964
812	urxvt::timer	965	urxvt::timer
813	->new	966	->new
814	->start (urxvt::NOW + $arg{after})	967	->after ($arg{after}, $arg{interval})
815	->cb (sub {	968	->cb ($arg{interval} ? $cb : sub {
816	$_[0]->stop; # need to cancel manually	969	$_[0]->stop; # need to cancel manually
817	$cb->();	970	$cb->();
818	})	971	})
819	}	972	}
820		973
821	sub io {	974	sub io {
822	my ($class, %arg) = @_;	975	my ($class, %arg) = @_;
823		976
824	my $cb = $arg{cb};	977	my $cb = $arg{cb};
		978	my $fd = fileno $arg{fh};
		979	defined $fd or $fd = $arg{fh};
825		980
826	bless [$arg{fh}, urxvt::iow	981	bless [$arg{fh}, urxvt::iow
827	->new	982	->new
828	->fd (fileno $arg{fh})	983	->fd ($fd)
829	->events (($arg{poll} =~ /r/ ? 1 : 0)	984	->events (($arg{poll} =~ /r/ ? 1 : 0)
830	| ($arg{poll} =~ /w/ ? 2 : 0))	985	| ($arg{poll} =~ /w/ ? 2 : 0))
831	->start	986	->start
832	->cb (sub {	987	->cb ($cb)
833	$cb->(($_[1] & 1 ? 'r' : '')
834	. ($_[1] & 2 ? 'w' : ''));
835	})],
836	urxvt::anyevent::	988	], urxvt::anyevent::
		989	}
		990
		991	sub idle {
		992	my ($class, %arg) = @_;
		993
		994	my $cb = $arg{cb};
		995
		996	urxvt::iw
		997	->new
		998	->start
		999	->cb ($cb)
		1000	}
		1001
		1002	sub child {
		1003	my ($class, %arg) = @_;
		1004
		1005	my $cb = $arg{cb};
		1006
		1007	urxvt::pw
		1008	->new
		1009	->start ($arg{pid})
		1010	->cb (sub {
		1011	$_[0]->stop; # need to cancel manually
		1012	$cb->($_[0]->rpid, $_[0]->rstatus);
		1013	})
837	}	1014	}
838		1015
839	sub DESTROY {	1016	sub DESTROY {
840	$_[0][1]->stop;	1017	$_[0][1]->stop;
841	}	1018	}
842		1019
843	sub condvar {	1020	# only needed for AnyEvent < 6 compatibility
844	bless \my $flag, urxvt::anyevent::condvar::	1021	sub one_event {
845	}
846
847	sub urxvt::anyevent::condvar::broadcast {
848	${$_[0]}++;
849	}
850
851	sub urxvt::anyevent::condvar::wait {
852	unless (${$_[0]}) {
853	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1022	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
854	}
855	}	1023	}
856		1024
857	package urxvt::term;	1025	package urxvt::term;
858		1026
859	=head2 The C<urxvt::term> Class	1027	=head2 The C<urxvt::term> Class
…		…
865	# find on_xxx subs in the package and register them	1033	# find on_xxx subs in the package and register them
866	# as hooks	1034	# as hooks
867	sub register_package {	1035	sub register_package {
868	my ($self, $pkg, $argv) = @_;	1036	my ($self, $pkg, $argv) = @_;
869		1037
		1038	no strict 'refs';
		1039
		1040	urxvt::verbose 6, "register package $pkg to $self";
		1041
		1042	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1043
870	my $proxy = bless {	1044	my $proxy = bless {
871	_pkg => $pkg,	1045	_pkg => $pkg,
		1046	_name => ${"$pkg\::_NAME"}, # hackish
872	argv => $argv,	1047	argv => $argv,
873	}, $pkg;	1048	}, $pkg;
874	Scalar::Util::weaken ($proxy->{term} = $self);	1049	Scalar::Util::weaken ($proxy->{term} = $self);
875		1050
876	$self->{_pkg}{$pkg} = $proxy;	1051	$self->{_pkg}{$pkg} = $proxy;
877		1052
…		…
880	$proxy->enable ($name => $ref);	1055	$proxy->enable ($name => $ref);
881	}	1056	}
882	}	1057	}
883	}	1058	}
884		1059
		1060	sub perl_libdirs {
		1061	map { split /:/ }
		1062	$_[0]->resource ("perl_lib"),
		1063	$ENV{URXVT_PERL_LIB},
		1064	"$ENV{HOME}/.urxvt/ext",
		1065	"$LIBDIR/perl"
		1066	}
		1067
		1068	sub scan_meta {
		1069	my ($self) = @_;
		1070	my @libdirs = perl_libdirs $self;
		1071
		1072	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1073
		1074	my %meta;
		1075
		1076	$self->{meta_libdirs} = join "\x00", @libdirs;
		1077	$self->{meta} = \%meta;
		1078
		1079	for my $dir (reverse @libdirs) {
		1080	opendir my $fh, $dir
		1081	or next;
		1082	for my $ext (readdir $fh) {
		1083	$ext ne "."
		1084	and $ext ne ".."
		1085	and open my $fh, "<", "$dir/$ext"
		1086	or next;
		1087
		1088	while (<$fh>) {
		1089	if (/^#:META:X_RESOURCE:(.*)/) {
		1090	my ($pattern, $type, $desc) = split /:/, $1;
		1091	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1092	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1093	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1094	} else {
		1095	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1096	}
		1097	} elsif (/^\s*(?:#|$)/) {
		1098	# skip other comments and empty lines
		1099	} else {
		1100	last; # stop parsing on first non-empty non-comment line
		1101	}
		1102	}
		1103	}
		1104	}
		1105	}
		1106
885	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1107	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
886		1108
887	Creates a new terminal, very similar as if you had started it with system	1109	Creates a new terminal, very similar as if you had started it with system
888	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1110	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
889	hash which defines the environment of the new terminal.	1111	hash which defines the environment of the new terminal.
890		1112
891	Croaks (and probably outputs an error message) if the new instance	1113	Croaks (and probably outputs an error message) if the new instance
892	couldn't be created. Returns C<undef> if the new instance didn't	1114	couldn't be created. Returns C<undef> if the new instance didn't
893	initialise perl, and the terminal object otherwise. The C<init> and	1115	initialise perl, and the terminal object otherwise. The C<init> and
894	C<start> hooks will be called during this call.	1116	C<start> hooks will be called before this call returns, and are free to
		1117	refer to global data (which is race free).
895		1118
896	=cut	1119	=cut
897		1120
898	sub new {	1121	sub new {
899	my ($class, $env, @args) = @_;	1122	my ($class, $env, @args) = @_;
900		1123
		1124	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1125	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1126
901	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1127	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
902	}	1128	}
903		1129
904	=item $term->destroy	1130	=item $term->destroy
905		1131
906	Destroy the terminal object (close the window, free resources	1132	Destroy the terminal object (close the window, free resources
907	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1133	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
908	watchers (timers, io watchers) are still active.	1134	watchers (timers, io watchers) are still active.
909		1135
		1136	=item $term->exec_async ($cmd[, @args])
		1137
		1138	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1139	("starts") programs in the background. This function takes care of setting
		1140	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1141	be preferred over explicit calls to C<exec> or C<system>.
		1142
		1143	Returns the pid of the subprocess or C<undef> on error.
		1144
		1145	=cut
		1146
		1147	sub exec_async {
		1148	my $self = shift;
		1149
		1150	my $pid = fork;
		1151
		1152	return $pid
		1153	if !defined $pid or $pid;
		1154
		1155	%ENV = %{ $self->env };
		1156
		1157	exec @_;
		1158	urxvt::_exit 255;
		1159	}
		1160
910	=item $isset = $term->option ($optval[, $set])	1161	=item $isset = $term->option ($optval[, $set])
911		1162
912	Returns true if the option specified by C<$optval> is enabled, and	1163	Returns true if the option specified by C<$optval> is enabled, and
913	optionally change it. All option values are stored by name in the hash	1164	optionally change it. All option values are stored by name in the hash
914	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1165	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
915		1166
916	Here is a a likely non-exhaustive list of option names, please see the	1167	Here is a likely non-exhaustive list of option names, please see the
917	source file F</src/optinc.h> to see the actual list:	1168	source file F</src/optinc.h> to see the actual list:
918		1169
919	borderLess console cursorBlink cursorUnderline hold iconic insecure	1170	borderLess buffered console cursorBlink cursorUnderline hold iconic
920	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1171	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1172	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
921	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1173	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
922	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1174	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
923	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1175	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
924	tripleclickwords utmpInhibit visualBell	1176	urgentOnBell utmpInhibit visualBell
925		1177
926	=item $value = $term->resource ($name[, $newval])	1178	=item $value = $term->resource ($name[, $newval])
927		1179
928	Returns the current resource value associated with a given name and	1180	Returns the current resource value associated with a given name and
929	optionally sets a new value. Setting values is most useful in the C<init>	1181	optionally sets a new value. Setting values is most useful in the C<init>
…		…
938	likely change).	1190	likely change).
939		1191
940	Please note that resource strings will currently only be freed when the	1192	Please note that resource strings will currently only be freed when the
941	terminal is destroyed, so changing options frequently will eat memory.	1193	terminal is destroyed, so changing options frequently will eat memory.
942		1194
943	Here is a a likely non-exhaustive list of resource names, not all of which	1195	Here is a likely non-exhaustive list of resource names, not all of which
944	are supported in every build, please see the source file F</src/rsinc.h>	1196	are supported in every build, please see the source file F</src/rsinc.h>
945	to see the actual list:	1197	to see the actual list:
946		1198
947	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1199	answerbackstring backgroundPixmap backspace_key blurradius
948	borderLess color cursorBlink cursorUnderline cutchars delete_key	1200	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
949	display_name embed ext_bwidth fade font geometry hold iconName	1201	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
950	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1202	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1203	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
951	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1204	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
952	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1205	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
953	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1206	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
954	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1207	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
955	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1208	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
956	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1209	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
957	shade term_name title transparent transparent_all tripleclickwords	1210	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1211	term_name title transient_for transparent tripleclickwords urgentOnBell
958	utmpInhibit visualBell	1212	utmpInhibit visualBell
959		1213
960	=cut	1214	=cut
961		1215
962	sub resource($$;$) {	1216	sub resource($$;$) {
963	my ($self, $name) = (shift, shift);	1217	my ($self, $name) = (shift, shift);
964	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1218	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
965	&urxvt::term::_resource	1219	goto &urxvt::term::_resource
966	}	1220	}
967		1221
968	=item $value = $term->x_resource ($pattern)	1222	=item $value = $term->x_resource ($pattern)
969		1223
970	Returns the X-Resource for the given pattern, excluding the program or	1224	Returns the X-Resource for the given pattern, excluding the program or
971	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1225	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
972	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1226	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
973	resource with that pattern exists.	1227	resource with that pattern exists.
974		1228
		1229	Extensions that define extra resource or command line arguments also need
		1230	to call this method to access their values.
		1231
		1232	If the method is called on an extension object (basically, from an
		1233	extension), then the special prefix C<%.> will be replaced by the name of
		1234	the extension and a dot, and the lone string C<%> will be replaced by the
		1235	extension name itself. This makes it possible to code extensions so you
		1236	can rename them and get a new set of commandline switches and resources
		1237	without having to change the actual code.
		1238
975	This method should only be called during the C<on_start> hook, as there is	1239	This method should only be called during the C<on_start> hook, as there is
976	only one resource database per display, and later invocations might return	1240	only one resource database per display, and later invocations might return
977	the wrong resources.	1241	the wrong resources.
978		1242
979	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1243	=item $value = $term->x_resource_boolean ($pattern)
980		1244
		1245	Like C<x_resource>, above, but interprets the string value as a boolean
		1246	and returns C<1> for true values, C<0> for false values and C<undef> if
		1247	the resource or option isn't specified.
		1248
		1249	You should always use this method to parse boolean resources.
		1250
		1251	=cut
		1252
		1253	sub x_resource_boolean {
		1254	my $res = &x_resource;
		1255
		1256	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1257	}
		1258
		1259	=item $success = $term->parse_keysym ($key, $octets)
		1260
981	Adds a keymap translation exactly as specified via a resource. See the	1261	Adds a key binding exactly as specified via a resource. See the
982	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1262	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1263
		1264	=item $term->register_command ($keysym, $modifiermask, $string)
		1265
		1266	Adds a key binding. This is a lower level api compared to
		1267	C<parse_keysym>, as it expects a parsed key description, and can be
		1268	used only inside either the C<on_init> hook, to add a binding, or the
		1269	C<on_register_command> hook, to modify a parsed binding.
983		1270
984	=item $rend = $term->rstyle ([$new_rstyle])	1271	=item $rend = $term->rstyle ([$new_rstyle])
985		1272
986	Return and optionally change the current rendition. Text that is output by	1273	Return and optionally change the current rendition. Text that is output by
987	the terminal application will use this style.	1274	the terminal application will use this style.
…		…
995		1282
996	=item ($row, $col) = $term->selection_beg ([$row, $col])	1283	=item ($row, $col) = $term->selection_beg ([$row, $col])
997		1284
998	=item ($row, $col) = $term->selection_end ([$row, $col])	1285	=item ($row, $col) = $term->selection_end ([$row, $col])
999		1286
1000	Return the current values of the selection mark, begin or end positions,	1287	Return the current values of the selection mark, begin or end positions.
1001	and optionally set them to new values.	1288
		1289	When arguments are given, then the selection coordinates are set to
		1290	C<$row> and C<$col>, and the selection screen is set to the current
		1291	screen.
		1292
		1293	=item $screen = $term->selection_screen ([$screen])
		1294
		1295	Returns the current selection screen, and then optionally sets it.
1002		1296
1003	=item $term->selection_make ($eventtime[, $rectangular])	1297	=item $term->selection_make ($eventtime[, $rectangular])
1004		1298
1005	Tries to make a selection as set by C<selection_beg> and	1299	Tries to make a selection as set by C<selection_beg> and
1006	C<selection_end>. If C<$rectangular> is true (default: false), a	1300	C<selection_end>. If C<$rectangular> is true (default: false), a
1007	rectangular selection will be made. This is the prefered function to make	1301	rectangular selection will be made. This is the preferred function to make
1008	a selection.	1302	a selection.
1009		1303
1010	=item $success = $term->selection_grab ($eventtime)	1304	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1011		1305
1012	Try to request the primary selection text from the server (for example, as	1306	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1307	true) selection from the server. The corresponding text can be set
1013	set by the next method). No visual feedback will be given. This function	1308	with the next method. No visual feedback will be given. This function
1014	is mostly useful from within C<on_sel_grab> hooks.	1309	is mostly useful from within C<on_sel_grab> hooks.
1015		1310
1016	=item $oldtext = $term->selection ([$newtext])	1311	=item $oldtext = $term->selection ([$newtext, $clipboard])
1017		1312
1018	Return the current selection text and optionally replace it by C<$newtext>.	1313	Return the current selection (clipboard if C<$clipboard> is true) text
		1314	and optionally replace it by C<$newtext>.
		1315
		1316	=item $term->selection_clear ([$clipboard])
		1317
		1318	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1019		1319
1020	=item $term->overlay_simple ($x, $y, $text)	1320	=item $term->overlay_simple ($x, $y, $text)
1021		1321
1022	Create a simple multi-line overlay box. See the next method for details.	1322	Create a simple multi-line overlay box. See the next method for details.
1023		1323
…		…
1053		1353
1054	The methods currently supported on C<urxvt::overlay> objects are:	1354	The methods currently supported on C<urxvt::overlay> objects are:
1055		1355
1056	=over 4	1356	=over 4
1057		1357
1058	=item $overlay->set ($x, $y, $text, $rend)	1358	=item $overlay->set ($x, $y, $text[, $rend])
1059		1359
1060	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1360	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1061	text in rxvt-unicode's special encoding and an array of rendition values	1361	text in rxvt-unicode's special encoding and an array of rendition values
1062	at a specific position inside the overlay.	1362	at a specific position inside the overlay.
		1363
		1364	If C<$rend> is missing, then the rendition will not be changed.
1063		1365
1064	=item $overlay->hide	1366	=item $overlay->hide
1065		1367
1066	If visible, hide the overlay, but do not destroy it.	1368	If visible, hide the overlay, but do not destroy it.
1067		1369
…		…
1137		1439
1138	Normally its not a good idea to use this function, as programs might be	1440	Normally its not a good idea to use this function, as programs might be
1139	confused by changes in cursor position or scrolling. Its useful inside a	1441	confused by changes in cursor position or scrolling. Its useful inside a
1140	C<on_add_lines> hook, though.	1442	C<on_add_lines> hook, though.
1141		1443
		1444	=item $term->scr_change_screen ($screen)
		1445
		1446	Switch to given screen - 0 primary, 1 secondary.
		1447
1142	=item $term->cmd_parse ($octets)	1448	=item $term->cmd_parse ($octets)
1143		1449
1144	Similar to C<scr_add_lines>, but the argument must be in the	1450	Similar to C<scr_add_lines>, but the argument must be in the
1145	locale-specific encoding of the terminal and can contain command sequences	1451	locale-specific encoding of the terminal and can contain command sequences
1146	(escape codes) that will be interpreted.	1452	(escape codes) that will be interpreted.
1147		1453
1148	=item $term->tt_write ($octets)	1454	=item $term->tt_write ($octets)
1149		1455
1150	Write the octets given in C<$data> to the tty (i.e. as program input). To	1456	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1151	pass characters instead of octets, you should convert your strings first	1457	pass characters instead of octets, you should convert your strings first
1152	to the locale-specific encoding using C<< $term->locale_encode >>.	1458	to the locale-specific encoding using C<< $term->locale_encode >>.
		1459
		1460	=item $term->tt_paste ($octets)
		1461
		1462	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1463	CR and bracketing the data with control sequences if bracketed paste mode
		1464	is set.
1153		1465
1154	=item $old_events = $term->pty_ev_events ([$new_events])	1466	=item $old_events = $term->pty_ev_events ([$new_events])
1155		1467
1156	Replaces the event mask of the pty watcher by the given event mask. Can	1468	Replaces the event mask of the pty watcher by the given event mask. Can
1157	be used to suppress input and output handling to the pty/tty. See the	1469	be used to suppress input and output handling to the pty/tty. See the
1158	description of C<< urxvt::timer->events >>. Make sure to always restore	1470	description of C<< urxvt::timer->events >>. Make sure to always restore
1159	the previous value.	1471	the previous value.
1160		1472
		1473	=item $fd = $term->pty_fd
		1474
		1475	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1476	is used.
		1477
1161	=item $windowid = $term->parent	1478	=item $windowid = $term->parent
1162		1479
1163	Return the window id of the toplevel window.	1480	Return the window id of the toplevel window.
1164		1481
1165	=item $windowid = $term->vt	1482	=item $windowid = $term->vt
…		…
1171	Adds the specified events to the vt event mask. Useful e.g. when you want	1488	Adds the specified events to the vt event mask. Useful e.g. when you want
1172	to receive pointer events all the times:	1489	to receive pointer events all the times:
1173		1490
1174	$term->vt_emask_add (urxvt::PointerMotionMask);	1491	$term->vt_emask_add (urxvt::PointerMotionMask);
1175		1492
		1493	=item $term->set_urgency ($set)
		1494
		1495	Enable/disable the urgency hint on the toplevel window.
		1496
		1497	=item $term->focus_in
		1498
		1499	=item $term->focus_out
		1500
		1501	=item $term->key_press ($state, $keycode[, $time])
		1502
		1503	=item $term->key_release ($state, $keycode[, $time])
		1504
		1505	Deliver various fake events to to terminal.
		1506
1176	=item $window_width = $term->width	1507	=item $window_width = $term->width
1177		1508
1178	=item $window_height = $term->height	1509	=item $window_height = $term->height
1179		1510
1180	=item $font_width = $term->fwidth	1511	=item $font_width = $term->fwidth
…		…
1210	=item $env = $term->env	1541	=item $env = $term->env
1211		1542
1212	Returns a copy of the environment in effect for the terminal as a hashref	1543	Returns a copy of the environment in effect for the terminal as a hashref
1213	similar to C<\%ENV>.	1544	similar to C<\%ENV>.
1214		1545
		1546	=item @envv = $term->envv
		1547
		1548	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1549
		1550	=item @argv = $term->argv
		1551
		1552	Return the argument vector as this terminal, similar to @ARGV, but
		1553	includes the program name as first element.
		1554
1215	=cut	1555	=cut
1216		1556
1217	sub env {	1557	sub env {
1218	if (my $env = $_[0]->_env) {
1219	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1558	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1220	} else {
1221	+{ %ENV }
1222	}
1223	}	1559	}
1224		1560
1225	=item $modifiermask = $term->ModLevel3Mask	1561	=item $modifiermask = $term->ModLevel3Mask
1226		1562
1227	=item $modifiermask = $term->ModMetaMask	1563	=item $modifiermask = $term->ModMetaMask
1228		1564
1229	=item $modifiermask = $term->ModNumLockMask	1565	=item $modifiermask = $term->ModNumLockMask
1230		1566
1231	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1567	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1232	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1568	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1569
		1570	=item $screen = $term->current_screen
		1571
		1572	Returns the currently displayed screen (0 primary, 1 secondary).
		1573
		1574	=item $cursor_is_hidden = $term->hidden_cursor
		1575
		1576	Returns whether the cursor is currently hidden or not.
1233		1577
1234	=item $view_start = $term->view_start ([$newvalue])	1578	=item $view_start = $term->view_start ([$newvalue])
1235		1579
1236	Returns the row number of the topmost displayed line. Maximum value is	1580	Returns the row number of the topmost displayed line. Maximum value is
1237	C<0>, which displays the normal terminal contents. Lower values scroll	1581	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1245		1589
1246	Used after changing terminal contents to display them.	1590	Used after changing terminal contents to display them.
1247		1591
1248	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1592	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1249		1593
1250	Returns the text of the entire row with number C<$row_number>. Row C<0>	1594	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1251	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1595	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1252	terminal line. The scrollback buffer starts at line C<-1> and extends to
1253	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1596	terminal line. Nothing will be returned if a nonexistent line
1254	is requested.	1597	is requested.
1255		1598
1256	If C<$new_text> is specified, it will replace characters in the current	1599	If C<$new_text> is specified, it will replace characters in the current
1257	line, starting at column C<$start_col> (default C<0>), which is useful	1600	line, starting at column C<$start_col> (default C<0>), which is useful
1258	to replace only parts of a line. The font index in the rendition will	1601	to replace only parts of a line. The font index in the rendition will
1259	automatically be updated.	1602	automatically be updated.
1260		1603
1261	C<$text> is in a special encoding: tabs and wide characters that use more	1604	C<$text> is in a special encoding: tabs and wide characters that use more
1262	than one cell when displayed are padded with urxvt::NOCHAR characters	1605	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1263	(C<chr 65535>). Characters with combining characters and other characters	1606	characters. Characters with combining characters and other characters that
1264	that do not fit into the normal tetx encoding will be replaced with	1607	do not fit into the normal text encoding will be replaced with characters
1265	characters in the private use area.	1608	in the private use area.
1266		1609
1267	You have to obey this encoding when changing text. The advantage is	1610	You have to obey this encoding when changing text. The advantage is
1268	that C<substr> and similar functions work on screen cells and not on	1611	that C<substr> and similar functions work on screen cells and not on
1269	characters.	1612	characters.
1270		1613
…		…
1414	where one character corresponds to one screen cell. See	1757	where one character corresponds to one screen cell. See
1415	C<< $term->ROW_t >> for details.	1758	C<< $term->ROW_t >> for details.
1416		1759
1417	=item $string = $term->special_decode $text	1760	=item $string = $term->special_decode $text
1418		1761
1419	Converts rxvt-unicodes text reprsentation into a perl string. See	1762	Converts rxvt-unicodes text representation into a perl string. See
1420	C<< $term->ROW_t >> for details.	1763	C<< $term->ROW_t >> for details.
1421		1764
1422	=item $success = $term->grab_button ($button, $modifiermask)	1765	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1423		1766
		1767	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1768
1424	Registers a synchronous button grab. See the XGrabButton manpage.	1769	Register/unregister a synchronous button grab. See the XGrabButton
		1770	manpage.
1425		1771
1426	=item $success = $term->grab ($eventtime[, $sync])	1772	=item $success = $term->grab ($eventtime[, $sync])
1427		1773
1428	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1774	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1429	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1775	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1430		1776
1431	=item $term->allow_events_async	1777	=item $term->allow_events_async
1432		1778
1433	Calls XAllowEvents with AsyncBoth for the most recent grab.	1779	Calls XAllowEvents with AsyncBoth for the most recent grab.
1434		1780
…		…
1441	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1787	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1442	recent grab.	1788	recent grab.
1443		1789
1444	=item $term->ungrab	1790	=item $term->ungrab
1445		1791
1446	Calls XUngrab for the most recent grab. Is called automatically on	1792	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1447	evaluation errors, as it is better to lose the grab in the error case as	1793	evaluation errors, as it is better to lose the grab in the error case as
1448	the session.	1794	the session.
		1795
		1796	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1797
		1798	=item $atom_name = $term->XGetAtomName ($atom)
		1799
		1800	=item @atoms = $term->XListProperties ($window)
		1801
		1802	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1803
		1804	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1805
		1806	=item $term->XDeleteProperty ($window, $property)
		1807
		1808	=item $window = $term->DefaultRootWindow
		1809
		1810	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1811
		1812	=item $term->XMapWindow ($window)
		1813
		1814	=item $term->XUnmapWindow ($window)
		1815
		1816	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1817
		1818	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1819
		1820	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1821
		1822	=item $keysym = $term->XStringToKeysym ($string)
		1823
		1824	=item $string = $term->XKeysymToString ($keysym)
		1825
		1826	Various X or X-related functions. The C<$term> object only serves as
		1827	the source of the display, otherwise those functions map more-or-less
		1828	directly onto the X functions of the same name.
1449		1829
1450	=back	1830	=back
1451		1831
1452	=cut	1832	=cut
1453		1833
…		…
1517	my ($self, $text, $cb) = @_;	1897	my ($self, $text, $cb) = @_;
1518		1898
1519	$self->add_item ({ type => "button", text => $text, activate => $cb});	1899	$self->add_item ({ type => "button", text => $text, activate => $cb});
1520	}	1900	}
1521		1901
1522	=item $popup->add_toggle ($text, $cb, $initial_value)	1902	=item $popup->add_toggle ($text, $initial_value, $cb)
1523		1903
1524	Adds a toggle/checkbox item to the popup. Teh callback gets called	1904	Adds a toggle/checkbox item to the popup. The callback gets called
1525	whenever it gets toggled, with a boolean indicating its value as its first	1905	whenever it gets toggled, with a boolean indicating its new value as its
1526	argument.	1906	first argument.
1527		1907
1528	=cut	1908	=cut
1529		1909
1530	sub add_toggle {	1910	sub add_toggle {
1531	my ($self, $text, $cb, $value) = @_;	1911	my ($self, $text, $value, $cb) = @_;
1532		1912
1533	my $item; $item = {	1913	my $item; $item = {
1534	type => "button",	1914	type => "button",
1535	text => " $text",	1915	text => " $text",
1536	value => $value,	1916	value => $value,
…		…
1555	my $env = $self->{term}->env;	1935	my $env = $self->{term}->env;
1556	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1936	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1557	delete $env->{LC_ALL};	1937	delete $env->{LC_ALL};
1558	$env->{LC_CTYPE} = $self->{term}->locale;	1938	$env->{LC_CTYPE} = $self->{term}->locale;
1559		1939
1560	urxvt::term->new ($env, $self->{term}->resource ("name"),	1940	my $term = urxvt::term->new (
1561	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1941	$env, "popup",
		1942	"--perl-lib" => "", "--perl-ext-common" => "",
		1943	"-pty-fd" => -1, "-sl" => 0,
		1944	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1562	"--transient-for" => $self->{term}->parent,	1945	"--transient-for" => $self->{term}->parent,
1563	"-display" => $self->{term}->display_id,	1946	"-display" => $self->{term}->display_id,
1564	"-pe" => "urxvt-popup")	1947	"-pe" => "urxvt-popup",
1565	or die "unable to create popup window\n";	1948	) or die "unable to create popup window\n";
		1949
		1950	unless (delete $term->{urxvt_popup_init_done}) {
		1951	$term->ungrab;
		1952	$term->destroy;
		1953	die "unable to initialise popup window\n";
		1954	}
1566	}	1955	}
1567		1956
1568	sub DESTROY {	1957	sub DESTROY {
1569	my ($self) = @_;	1958	my ($self) = @_;
1570		1959
1571	delete $self->{term}{_destroy}{$self};	1960	delete $self->{term}{_destroy}{$self};
1572	$self->{term}->ungrab;	1961	$self->{term}->ungrab;
1573	}	1962	}
1574		1963
1575	=back	1964	=back
		1965
		1966	=cut
		1967
		1968	package urxvt::watcher;
1576		1969
1577	=head2 The C<urxvt::timer> Class	1970	=head2 The C<urxvt::timer> Class
1578		1971
1579	This class implements timer watchers/events. Time is represented as a	1972	This class implements timer watchers/events. Time is represented as a
1580	fractional number of seconds since the epoch. Example:	1973	fractional number of seconds since the epoch. Example:
…		…
1584	->new	1977	->new
1585	->interval (1)	1978	->interval (1)
1586	->cb (sub {	1979	->cb (sub {
1587	$term->{overlay}->set (0, 0,	1980	$term->{overlay}->set (0, 0,
1588	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1981	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1589	});	1982	});
1590		1983
1591	=over 4	1984	=over 4
1592		1985
1593	=item $timer = new urxvt::timer	1986	=item $timer = new urxvt::timer
1594		1987
…		…
1597		1990
1598	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1991	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1599		1992
1600	Set the callback to be called when the timer triggers.	1993	Set the callback to be called when the timer triggers.
1601		1994
1602	=item $tstamp = $timer->at
1603
1604	Return the time this watcher will fire next.
1605
1606	=item $timer = $timer->set ($tstamp)	1995	=item $timer = $timer->set ($tstamp[, $interval])
1607		1996
1608	Set the time the event is generated to $tstamp.	1997	Set the time the event is generated to $tstamp (and optionally specifies a
		1998	new $interval).
1609		1999
1610	=item $timer = $timer->interval ($interval)	2000	=item $timer = $timer->interval ($interval)
1611		2001
1612	Normally (and when C<$interval> is C<0>), the timer will automatically	2002	By default (and when C<$interval> is C<0>), the timer will automatically
1613	stop after it has fired once. If C<$interval> is non-zero, then the timer	2003	stop after it has fired once. If C<$interval> is non-zero, then the timer
1614	is automatically rescheduled at the given intervals.	2004	is automatically rescheduled at the given intervals.
1615		2005
1616	=item $timer = $timer->start	2006	=item $timer = $timer->start
1617		2007
1618	Start the timer.	2008	Start the timer.
1619		2009
1620	=item $timer = $timer->start ($tstamp)	2010	=item $timer = $timer->start ($tstamp[, $interval])
1621		2011
1622	Set the event trigger time to C<$tstamp> and start the timer.	2012	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2013	also replaces the interval.
		2014
		2015	=item $timer = $timer->after ($delay[, $interval])
		2016
		2017	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1623		2018
1624	=item $timer = $timer->stop	2019	=item $timer = $timer->stop
1625		2020
1626	Stop the timer.	2021	Stop the timer.
1627		2022
…		…
1633		2028
1634	$term->{socket} = ...	2029	$term->{socket} = ...
1635	$term->{iow} = urxvt::iow	2030	$term->{iow} = urxvt::iow
1636	->new	2031	->new
1637	->fd (fileno $term->{socket})	2032	->fd (fileno $term->{socket})
1638	->events (urxvt::EVENT_READ)	2033	->events (urxvt::EV_READ)
1639	->start	2034	->start
1640	->cb (sub {	2035	->cb (sub {
1641	my ($iow, $revents) = @_;	2036	my ($iow, $revents) = @_;
1642	# $revents must be 1 here, no need to check	2037	# $revents must be 1 here, no need to check
1643	sysread $term->{socket}, my $buf, 8192	2038	sysread $term->{socket}, my $buf, 8192
…		…
1656	Set the callback to be called when io events are triggered. C<$reventmask>	2051	Set the callback to be called when io events are triggered. C<$reventmask>
1657	is a bitset as described in the C<events> method.	2052	is a bitset as described in the C<events> method.
1658		2053
1659	=item $iow = $iow->fd ($fd)	2054	=item $iow = $iow->fd ($fd)
1660		2055
1661	Set the filedescriptor (not handle) to watch.	2056	Set the file descriptor (not handle) to watch.
1662		2057
1663	=item $iow = $iow->events ($eventmask)	2058	=item $iow = $iow->events ($eventmask)
1664		2059
1665	Set the event mask to watch. The only allowed values are	2060	Set the event mask to watch. The only allowed values are
1666	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2061	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1667	together, or C<urxvt::EVENT_NONE>.	2062	together, or C<urxvt::EV_NONE>.
1668		2063
1669	=item $iow = $iow->start	2064	=item $iow = $iow->start
1670		2065
1671	Start watching for requested events on the given handle.	2066	Start watching for requested events on the given handle.
1672		2067
1673	=item $iow = $iow->stop	2068	=item $iow = $iow->stop
1674		2069
1675	Stop watching for events on the given filehandle.	2070	Stop watching for events on the given file handle.
		2071
		2072	=back
		2073
		2074	=head2 The C<urxvt::iw> Class
		2075
		2076	This class implements idle watchers, that get called automatically when
		2077	the process is idle. They should return as fast as possible, after doing
		2078	some useful work.
		2079
		2080	=over 4
		2081
		2082	=item $iw = new urxvt::iw
		2083
		2084	Create a new idle watcher object in stopped state.
		2085
		2086	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2087
		2088	Set the callback to be called when the watcher triggers.
		2089
		2090	=item $timer = $timer->start
		2091
		2092	Start the watcher.
		2093
		2094	=item $timer = $timer->stop
		2095
		2096	Stop the watcher.
		2097
		2098	=back
		2099
		2100	=head2 The C<urxvt::pw> Class
		2101
		2102	This class implements process watchers. They create an event whenever a
		2103	process exits, after which they stop automatically.
		2104
		2105	my $pid = fork;
		2106	...
		2107	$term->{pw} = urxvt::pw
		2108	->new
		2109	->start ($pid)
		2110	->cb (sub {
		2111	my ($pw, $exit_status) = @_;
		2112	...
		2113	});
		2114
		2115	=over 4
		2116
		2117	=item $pw = new urxvt::pw
		2118
		2119	Create a new process watcher in stopped state.
		2120
		2121	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2122
		2123	Set the callback to be called when the timer triggers.
		2124
		2125	=item $pw = $timer->start ($pid)
		2126
		2127	Tells the watcher to start watching for process C<$pid>.
		2128
		2129	=item $pw = $pw->stop
		2130
		2131	Stop the watcher.
1676		2132
1677	=back	2133	=back
1678		2134
1679	=head1 ENVIRONMENT	2135	=head1 ENVIRONMENT
1680		2136
…		…
1689		2145
1690	=item >= 3 - script loading and management	2146	=item >= 3 - script loading and management
1691		2147
1692	=item >=10 - all called hooks	2148	=item >=10 - all called hooks
1693		2149
1694	=item >=11 - hook reutrn values	2150	=item >=11 - hook return values
1695		2151
1696	=back	2152	=back
1697		2153
1698	=head1 AUTHOR	2154	=head1 AUTHOR
1699		2155
1700	Marc Lehmann <pcg@goof.com>	2156	Marc Lehmann <schmorp@schmorp.de>
1701	http://software.schmorp.de/pkg/rxvt-unicode	2157	http://software.schmorp.de/pkg/rxvt-unicode
1702		2158
1703	=cut	2159	=cut
1704		2160
1705	1	2161	1
		2162
		2163	# vim: sw=3:

Diff Legend

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