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.110 by root, Thu Jan 19 16:22:13 2006 UTC vs.
Revision 1.224 by root, Sat Jul 14 08:00:34 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	Other extensions can extend this popup menu by pushing a code reference
95	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
96	popup is displayed.
97
98	It's sole argument is the popup menu, which can be modified. The selection
99	is in C<$_>, which can be used to decide wether to add something or not.
100	It should either return nothing or a string and a code reference. The
101	string will be used as button text and the code reference will be called
102	when the button gets activated and should transform C<$_>.
103
104	The following will add an entry C<a to b> that transforms all C<a>s in
105	the selection to C<b>s, but only if the selection currently contains any
106	C<a>s:
107
108	push @{ $self->{term}{selection_popup_hook} }, sub {
109	/a/ ? ("a to be" => sub { s/a/b/g }
110	: ()
111	};
112
113	=item searchable-scrollback<hotkey> (enabled by default)
114
115	Adds regex search functionality to the scrollback buffer, triggered
116	by a hotkey (default: C<M-s>). While in search mode, normal terminal
117	input/output is suspended and a regex is displayed at the bottom of the
118	screen.
119
120	Inputting characters appends them to the regex and continues incremental
121	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
122	search upwards/downwards in the scrollback buffer, C<End> jumps to the
123	bottom. C<Escape> leaves search mode and returns to the point where search
124	was started, while C<Enter> or C<Return> stay at the current position and
125	additionally stores the first match in the current line into the primary
126	selection.
127
128	=item selection-autotransform
129
130	This selection allows you to do automatic transforms on a selection
131	whenever a selection is made.
132
133	It works by specifying perl snippets (most useful is a single C<s///>
134	operator) that modify C<$_> as resources:
135
136	URxvt.selection-autotransform.0: transform
137	URxvt.selection-autotransform.1: transform
138	...
139
140	For example, the following will transform selections of the form
141	C<filename:number>, often seen in compiler messages, into C<vi +$filename
142	$word>:
143
144	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
145
146	And this example matches the same,but replaces it with vi-commands you can
147	paste directly into your (vi :) editor:
148
149	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
150
151	Of course, this can be modified to suit your needs and your editor :)
152
153	To expand the example above to typical perl error messages ("XXX at
154	FILENAME line YYY."), you need a slightly more elaborate solution:
155
156	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
157	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
158
159	The first line tells the selection code to treat the unchanging part of
160	every error message as a selection pattern, and the second line transforms
161	the message into vi commands to load the file.
162
163	=item mark-urls
164
165	Uses per-line display filtering (C<on_line_update>) to underline urls and
166	make them clickable. When middle-clicked, the program specified in the
167	resource C<urlLauncher> (default C<x-www-browser>) will be started with
168	the URL as first argument.
169
170	=item automove-background
171
172	This is basically a one-line extension that dynamically changes the background pixmap offset
173	to the window position, in effect creating the same effect as pseudo transparency with
174	a custom pixmap. No scaling is supported in this mode. Exmaple:
175
176	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
177
178	=item block-graphics-to-ascii
179
180	A not very useful example of filtering all text output to the terminal,
181	by replacing all line-drawing characters (U+2500 .. U+259F) by a
182	similar-looking ascii character.
183
184	=item digital-clock
185
186	Displays a digital clock using the built-in overlay.
187
188	=item example-refresh-hooks
189
190	Displays a very simple digital clock in the upper right corner of the
191	window. Illustrates overwriting the refresh callbacks to create your own
192	overlays or changes.
193
194	=item selection-pastebin
195
196	This is a little rarely useful extension that Uploads the selection as
197	textfile to a remote site (or does other things). (The implementation is
198	not currently secure for use in a multiuser environment as it writes to
199	F</tmp> directly.).
200
201	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
202	i.e.
203
204	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
205
206	Pressing this combination runs a command with C<%> replaced by the name of
207	the textfile. This command can be set via a resource:
208
209	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
210
211	And the default is likely not useful to anybody but the few people around
212	here :)
213
214	The name of the textfile is the hex encoded md5 sum of the selection, so
215	the same content should lead to the same filename.
216
217	After a successful upload the selection will be replaced by the text given
218	in the C<selection-pastebin-url> resource (again, the % is the placeholder
219	for the filename):
220
221	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
222
223	=back
224		50
225	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
226		52
227	=head2 General API Considerations	53	=head2 General API Considerations
228		54
…		…
242		68
243	=over 4	69	=over 4
244		70
245	=item $text	71	=item $text
246		72
247	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
248	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.
249		75
250	=item $string	76	=item $string
251		77
252	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
…		…
256	=item $octets	82	=item $octets
257		83
258	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
259	locale-specific way.	85	locale-specific way.
260		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
261	=back	93	=back
262		94
263	=head2 Extension Objects	95	=head2 Extension Objects
264		96
265	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
266	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,
267	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
268	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
269	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
270	use.	103	internal use.
271		104
272	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
273	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
274		107
275	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
276		109	the C<urxvt::extension> section below.
277	=over 4
278
279	=item $urxvt_term = $self->{term}
280
281	Returns the C<urxvt::term> object associated with this instance of the
282	extension. This member I<must not> be changed in any way.
283
284	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
285
286	Dynamically enable the given hooks (named without the C<on_> prefix) for
287	this extension, replacing any previous hook. This is useful when you want
288	to overwrite time-critical hooks only temporarily.
289
290	=item $self->disable ($hook_name[, $hook_name..])
291
292	Dynamically disable the given hooks.
293
294	=back
295		110
296	=head2 Hooks	111	=head2 Hooks
297		112
298	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
299	called whenever the relevant event happens.	114	called whenever the relevant event happens.
300		115
301	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
302	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
303		118
304	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
305	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
306	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.
307		122
308	I<< When in doubt, return a false value (preferably C<()>). >>	123	I<< When in doubt, return a false value (preferably C<()>). >>
309		124
310	=over 4	125	=over 4
311		126
312	=item on_init $term	127	=item on_init $term
313		128
314	Called after a new terminal object has been initialized, but before	129	Called after a new terminal object has been initialized, but before
315	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
316	call or deliver senseless data, as terminal size and other characteristics	131	call or deliver senseless data, as terminal size and other characteristics
317	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
318	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).
319		145
320	=item on_reset $term	146	=item on_reset $term
321		147
322	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
323	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
324	variables.	150	variables.
325		151
326	=item on_start $term
327
328	Called at the very end of initialisation of a new terminal, just before
329	returning to the mainloop.
330
331	=item on_child_start $term, $pid	152	=item on_child_start $term, $pid
332		153
333	Called just after the child process has been C<fork>ed.	154	Called just after the child process has been C<fork>ed.
334		155
335	=item on_child_exit $term, $status	156	=item on_child_exit $term, $status
…		…
350		171
351	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
352	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
353	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
354		175
355	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.
356		177
357	=item on_sel_extend $term	178	=item on_sel_extend $term
358		179
359	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
360	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
361	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
362	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
363	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
364	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
365		186
366	See the F<selection> example extension.	187	See the F<selection> example extension.
367		188
368	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
369		190
370	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
371	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
372	show this many lines of scrollback.	193	show this many lines of scrollback.
373		194
374	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
375		196
…		…
379		200
380	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,
381	$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
382	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
383		204
384	=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
385		216
386	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
387	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
388	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
389	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,
390	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
391	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	}
392		233
393	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,
394	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
395	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.
396		240
397	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
398		242
399	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
400	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
…		…
405	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
406		250
407	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
408	suppress or filter tty input.	252	suppress or filter tty input.
409		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
410	=item on_line_update $term, $row	261	=item on_line_update $term, $row
411		262
412	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
413	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
414	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,
…		…
421	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
422	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
423		274
424	=item on_refresh_begin $term	275	=item on_refresh_begin $term
425		276
426	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
427	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
428	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
429	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
430		281
431	=item on_refresh_end $term	282	=item on_refresh_end $term
432		283
433	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>.
434		285
435	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string
436		287
437	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
438	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>
439	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.
440		307
441	=item on_x_event $term, $event	308	=item on_x_event $term, $event
442		309
443	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
444	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
445	members are not passed.	312	members are not passed.
446		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
447	=item on_focus_in $term	318	=item on_focus_in $term
448		319
449	Called whenever the window gets the keyboard focus, before rxvt-unicode	320	Called whenever the window gets the keyboard focus, before rxvt-unicode
450	does focus in processing.	321	does focus in processing.
451		322
452	=item on_focus_out $term	323	=item on_focus_out $term
453		324
454	Called wheneever the window loses keyboard focus, before rxvt-unicode does	325	Called whenever the window loses keyboard focus, before rxvt-unicode does
455	focus out processing.	326	focus out processing.
456		327
457	=item on_configure_notify $term, $event	328	=item on_configure_notify $term, $event
458		329
		330	=item on_property_notify $term, $event
		331
459	=item on_key_press $term, $event, $keysym, $octets	332	=item on_key_press $term, $event, $keysym, $octets
460		333
461	=item on_key_release $term, $event, $keysym	334	=item on_key_release $term, $event, $keysym
462		335
463	=item on_button_press $term, $event	336	=item on_button_press $term, $event
…		…
468		341
469	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
470		343
471	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
472		345
473	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
474	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.
475		348
476	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
477	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
478	and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
479		352
480	C<on_key_press> additionally receives the string rxvt-unicode would	353	C<on_key_press> additionally receives the string rxvt-unicode would
481	output, if any, in locale-specific encoding.	354	output, if any, in locale-specific encoding.
482		355
483	subwindow.	356	subwindow.
484		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
485	=back	371	=back
486		372
487	=cut	373	=cut
488		374
489	package urxvt;	375	package urxvt;
490		376
491	use utf8;	377	use utf8;
492	use strict;	378	use strict 'vars';
493	use Carp ();	379	use Carp ();
494	use Scalar::Util ();	380	use Scalar::Util ();
495	use List::Util ();	381	use List::Util ();
496		382
497	our $VERSION = 1;	383	our $VERSION = 1;
498	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.
499	our @HOOKNAME;	387	our @HOOKNAME;
500	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
501	our %OPTION;	389	our %OPTION;
502		390
503	our $LIBDIR;	391	our $LIBDIR;
504	our $RESNAME;	392	our $RESNAME;
505	our $RESCLASS;	393	our $RESCLASS;
506	our $RXVTNAME;	394	our $RXVTNAME;
507		395
		396	our $NOCHAR = chr 0xffff;
		397
508	=head2 Variables in the C<urxvt> Package	398	=head2 Variables in the C<urxvt> Package
509		399
510	=over 4	400	=over 4
511		401
512	=item $urxvt::LIBDIR	402	=item $urxvt::LIBDIR
…		…
525	=item $urxvt::TERM	415	=item $urxvt::TERM
526		416
527	The current terminal. This variable stores the current C<urxvt::term>	417	The current terminal. This variable stores the current C<urxvt::term>
528	object, whenever a callback/hook is executing.	418	object, whenever a callback/hook is executing.
529		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
530	=back	436	=back
531		437
532	=head2 Functions in the C<urxvt> Package	438	=head2 Functions in the C<urxvt> Package
533		439
534	=over 4	440	=over 4
535		441
536	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
537		443
538	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
539	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
540	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
541		448
542	=item urxvt::warn $string	449	=item urxvt::warn $string
543		450
544	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
545	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
546	that calls this function.	453	that calls this function.
547		454
548	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
549	correct place, e.g. on stderr of the connecting urxvtc client.	456	correct place, e.g. on stderr of the connecting urxvtc client.
550		457
551	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).
552		466
553	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
554		468
555	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
556		470
…		…
599		513
600	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
601		515
602	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
603		517
604	=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
605		520
606	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
607	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
608	the bitset.	523	the bitset.
609		524
…		…
614	Return the foreground/background colour index, respectively.	529	Return the foreground/background colour index, respectively.
615		530
616	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	531	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
617		532
618	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	533	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		534
		535	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
619		536
620	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
621	specified one.	538	specified one.
622		539
623	=item $value = urxvt::GET_CUSTOM $rend	540	=item $value = urxvt::GET_CUSTOM $rend
…		…
642	unless $msg =~ /\n$/;	559	unless $msg =~ /\n$/;
643	urxvt::warn ($msg);	560	urxvt::warn ($msg);
644	};	561	};
645	}	562	}
646		563
		564	no warnings 'utf8';
		565
		566	sub parse_resource {
		567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		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	}
		624	}
		625
647	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
648		627
649	sub verbose {	628	sub verbose {
650	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
651	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
…		…
654	my %extension_pkg;	633	my %extension_pkg;
655		634
656	# load a single script into its own package, once only	635	# load a single script into its own package, once only
657	sub extension_package($) {	636	sub extension_package($) {
658	my ($path) = @_;	637	my ($path) = @_;
659
660	no strict 'refs';
661		638
662	$extension_pkg{$path} ||= do {	639	$extension_pkg{$path} ||= do {
663	$path =~ /([^\/\\]+)$/;	640	$path =~ /([^\/\\]+)$/;
664	my $pkg = $1;	641	my $pkg = $1;
665	$pkg =~ s/[^[:word:]]/_/g;	642	$pkg =~ s/[^[:word:]]/_/g;
666	$pkg = "urxvt::ext::$pkg";	643	$pkg = "urxvt::ext::$pkg";
667		644
668	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
669		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		648
670	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
671	or die "$path: $!";	650	or die "$path: $!";
672		651
673	@{"$pkg\::ISA"} = urxvt::term::extension::;
674
675	my $source =	652	my $source =
676	"package $pkg; use strict; use utf8;\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
677	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
678	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
679	. "\n};\n1";	656	. "\n};\n1";
680		657
681	eval $source	658	eval $source
…		…
691	sub invoke {	668	sub invoke {
692	local $TERM = shift;	669	local $TERM = shift;
693	my $htype = shift;	670	my $htype = shift;
694		671
695	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
696	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
697		674
698	my %ext_arg;	675	my %ext_arg;
699		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} },
700	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
701	if ($_ eq "default") {	690	if ($_ eq "default") {
702	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	691	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
703	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
704	delete $ext_arg{$1};	693	delete $ext_arg{$1};
705	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
706	push @{ $ext_arg{$1} }, $2;	695	push @{ $ext_arg{$1} }, $2;
707	} else {	696	} else {
708	$ext_arg{$_} ||= [];	697	$ext_arg{$_} ||= [];
709	}	698	}
710	}	699	}
711		700
712	while (my ($ext, $argv) = each %ext_arg) {	701	for my $ext (sort keys %ext_arg) {
713	my @files = grep -f $_, map "$_/$ext", @dirs;	702	my @files = grep -f $_, map "$_/$ext", @dirs;
714		703
715	if (@files) {	704	if (@files) {
716	$TERM->register_package (extension_package $files[0], $argv);	705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
717	} else {	706	} else {
718	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";
719	}	708	}
720	}	709	}
721		710
…		…
727		716
728	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
729	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
730	if $verbosity >= 10;	719	if $verbosity >= 10;
731		720
732	keys %$cb;	721	for my $pkg (keys %$cb) {
733
734	while (my ($pkg, $cb) = each %$cb) {
735	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
736	and last;	723	$retval ||= $retval_;
737		724
738	if ($@) {	725	if ($@) {
739	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
740	warn $@;	727	warn $@;
741	}	728	}
…		…
754	}	741	}
755		742
756	$retval	743	$retval
757	}	744	}
758		745
759	# urxvt::term::extension	746	sub SET_COLOR($$$) {
		747	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		748	}
		749
		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	}
760		774
761	package urxvt::term::extension;	775	package urxvt::term::extension;
762		776
763	sub enable {	777	=head2 The C<urxvt::term::extension> class
764	my ($self, %hook) = @_;
765	my $pkg = $self->{_pkg};
766		778
767	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
768	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
769	defined $htype
770	or Carp::croak "unsupported hook type '$name'";
771		781
772	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
773	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
774		784
775	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
776	}	786	objects, in addition to call methods documented for the <urxvt::term>
777	}	787	class.
778		788
779	sub disable {	789	=over 4
780	my ($self, @hook) = @_;
781	my $pkg = $self->{_pkg};
782		790
783	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
784	my $htype = $HOOKTYPE{uc $name};
785	defined $htype
786	or Carp::croak "unsupported hook type '$name'";
787		792
788	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
789	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
790	}	795
791	}	796	=cut
792		797
793	our $AUTOLOAD;	798	our $AUTOLOAD;
794		799
795	sub AUTOLOAD {	800	sub AUTOLOAD {
796	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
809		814
810	sub DESTROY {	815	sub DESTROY {
811	# nop	816	# nop
812	}	817	}
813		818
814	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
815		820
816	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
817	${$_[0]}->();	822	${$_[0]}->();
818	}	823	}
819		824
820	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
821	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
822	}	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	delete $term->{_hook}[$htype]{$id};
		890	$term->set_should_invoke ($htype, -1);
		891	}
		892	}
		893
		894	sub on {
		895	my ($self, %hook) = @_;
		896
		897	my $term = $self->{term};
		898
		899	my %disable = ( "" => $term );
		900
		901	while (my ($name, $cb) = each %hook) {
		902	my $htype = $HOOKTYPE{uc $name};
		903	defined $htype
		904	or Carp::croak "unsupported hook type '$name'";
		905
		906	$term->set_should_invoke ($htype, +1);
		907	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		908	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		909	}
		910
		911	bless \%disable, "urxvt::extension::on_disable"
		912	}
		913
		914	=item $self->x_resource ($pattern)
		915
		916	=item $self->x_resource_boolean ($pattern)
		917
		918	These methods support an additional C<%> prefix when called on an
		919	extension object - see the description of these methods in the
		920	C<urxvt::term> class for details.
		921
		922	=cut
		923
		924	sub x_resource {
		925	my ($self, $name) = @_;
		926	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		927	$self->{term}->x_resource ($name)
		928	}
		929
		930	sub x_resource_boolean {
		931	my ($self, $name) = @_;
		932	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		933	$self->{term}->x_resource_boolean ($name)
		934	}
		935
		936	=back
		937
		938	=cut
823		939
824	package urxvt::anyevent;	940	package urxvt::anyevent;
825		941
826	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
827		943
828	The sole purpose of this class is to deliver an interface to the	944	The sole purpose of this class is to deliver an interface to the
829	C<AnyEvent> module - any module using it will work inside urxvt without	945	C<AnyEvent> module - any module using it will work inside urxvt without
830	further programming. The only exception is that you cannot wait on	946	further programming. The only exception is that you cannot wait on
831	condition variables, but non-blocking condvar use is ok. What this means	947	condition variables, but non-blocking condvar use is ok.
832	is that you cannot use blocking APIs, but the non-blocking variant should
833	work.
834		948
835	=cut	949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
836		951
		952	=cut
		953
837	our $VERSION = 1;	954	our $VERSION = '5.23';
838		955
839	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	956	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
840	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	957	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
841		958
842	sub timer {	959	sub timer {
…		…
844		961
845	my $cb = $arg{cb};	962	my $cb = $arg{cb};
846		963
847	urxvt::timer	964	urxvt::timer
848	->new	965	->new
849	->start (urxvt::NOW + $arg{after})	966	->after ($arg{after}, $arg{interval})
850	->cb (sub {	967	->cb ($arg{interval} ? $cb : sub {
851	$_[0]->stop; # need to cancel manually	968	$_[0]->stop; # need to cancel manually
852	$cb->();	969	$cb->();
853	})	970	})
854	}	971	}
855		972
856	sub io {	973	sub io {
857	my ($class, %arg) = @_;	974	my ($class, %arg) = @_;
858		975
859	my $cb = $arg{cb};	976	my $cb = $arg{cb};
		977	my $fd = fileno $arg{fh};
		978	defined $fd or $fd = $arg{fh};
860		979
861	bless [$arg{fh}, urxvt::iow	980	bless [$arg{fh}, urxvt::iow
862	->new	981	->new
863	->fd (fileno $arg{fh})	982	->fd ($fd)
864	->events (($arg{poll} =~ /r/ ? 1 : 0)	983	->events (($arg{poll} =~ /r/ ? 1 : 0)
865	| ($arg{poll} =~ /w/ ? 2 : 0))	984	| ($arg{poll} =~ /w/ ? 2 : 0))
866	->start	985	->start
867	->cb (sub {	986	->cb ($cb)
868	$cb->(($_[1] & 1 ? 'r' : '')
869	. ($_[1] & 2 ? 'w' : ''));
870	})],
871	urxvt::anyevent::	987	], urxvt::anyevent::
		988	}
		989
		990	sub idle {
		991	my ($class, %arg) = @_;
		992
		993	my $cb = $arg{cb};
		994
		995	urxvt::iw
		996	->new
		997	->start
		998	->cb ($cb)
		999	}
		1000
		1001	sub child {
		1002	my ($class, %arg) = @_;
		1003
		1004	my $cb = $arg{cb};
		1005
		1006	urxvt::pw
		1007	->new
		1008	->start ($arg{pid})
		1009	->cb (sub {
		1010	$_[0]->stop; # need to cancel manually
		1011	$cb->($_[0]->rpid, $_[0]->rstatus);
		1012	})
872	}	1013	}
873		1014
874	sub DESTROY {	1015	sub DESTROY {
875	$_[0][1]->stop;	1016	$_[0][1]->stop;
876	}	1017	}
877		1018
878	sub condvar {	1019	# only needed for AnyEvent < 6 compatibility
879	bless \my $flag, urxvt::anyevent::condvar::	1020	sub one_event {
880	}
881
882	sub urxvt::anyevent::condvar::broadcast {
883	${$_[0]}++;
884	}
885
886	sub urxvt::anyevent::condvar::wait {
887	unless (${$_[0]}) {
888	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1021	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
889	}
890	}	1022	}
891		1023
892	package urxvt::term;	1024	package urxvt::term;
893		1025
894	=head2 The C<urxvt::term> Class	1026	=head2 The C<urxvt::term> Class
…		…
900	# find on_xxx subs in the package and register them	1032	# find on_xxx subs in the package and register them
901	# as hooks	1033	# as hooks
902	sub register_package {	1034	sub register_package {
903	my ($self, $pkg, $argv) = @_;	1035	my ($self, $pkg, $argv) = @_;
904		1036
		1037	no strict 'refs';
		1038
		1039	urxvt::verbose 6, "register package $pkg to $self";
		1040
		1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1042
905	my $proxy = bless {	1043	my $proxy = bless {
906	_pkg => $pkg,	1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
907	argv => $argv,	1046	argv => $argv,
908	}, $pkg;	1047	}, $pkg;
909	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
910		1049
911	$self->{_pkg}{$pkg} = $proxy;	1050	$self->{_pkg}{$pkg} = $proxy;
912		1051
…		…
915	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
916	}	1055	}
917	}	1056	}
918	}	1057	}
919		1058
		1059	sub perl_libdirs {
		1060	map { split /:/ }
		1061	$_[0]->resource ("perl_lib"),
		1062	$ENV{URXVT_PERL_LIB},
		1063	"$ENV{HOME}/.urxvt/ext",
		1064	"$LIBDIR/perl"
		1065	}
		1066
		1067	sub scan_meta {
		1068	my ($self) = @_;
		1069	my @libdirs = perl_libdirs $self;
		1070
		1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1072
		1073	my %meta;
		1074
		1075	$self->{meta_libdirs} = join "\x00", @libdirs;
		1076	$self->{meta} = \%meta;
		1077
		1078	for my $dir (reverse @libdirs) {
		1079	opendir my $fh, $dir
		1080	or next;
		1081	for my $ext (readdir $fh) {
		1082	$ext ne "."
		1083	and $ext ne ".."
		1084	and open my $fh, "<", "$dir/$ext"
		1085	or next;
		1086
		1087	while (<$fh>) {
		1088	if (/^#:META:X_RESOURCE:(.*)/) {
		1089	my ($pattern, $type, $desc) = split /:/, $1;
		1090	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1091	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1092	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1093	} else {
		1094	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1095	}
		1096	} elsif (/^\s*(?:#|$)/) {
		1097	# skip other comments and empty lines
		1098	} else {
		1099	last; # stop parsing on first non-empty non-comment line
		1100	}
		1101	}
		1102	}
		1103	}
		1104	}
		1105
920	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1106	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
921		1107
922	Creates a new terminal, very similar as if you had started it with system	1108	Creates a new terminal, very similar as if you had started it with system
923	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1109	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
924	hash which defines the environment of the new terminal.	1110	hash which defines the environment of the new terminal.
925		1111
926	Croaks (and probably outputs an error message) if the new instance	1112	Croaks (and probably outputs an error message) if the new instance
927	couldn't be created. Returns C<undef> if the new instance didn't	1113	couldn't be created. Returns C<undef> if the new instance didn't
928	initialise perl, and the terminal object otherwise. The C<init> and	1114	initialise perl, and the terminal object otherwise. The C<init> and
929	C<start> hooks will be called during this call.	1115	C<start> hooks will be called before this call returns, and are free to
		1116	refer to global data (which is race free).
930		1117
931	=cut	1118	=cut
932		1119
933	sub new {	1120	sub new {
934	my ($class, $env, @args) = @_;	1121	my ($class, $env, @args) = @_;
935		1122
		1123	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1124	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1125
936	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1126	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
937	}	1127	}
938		1128
939	=item $term->destroy	1129	=item $term->destroy
940		1130
941	Destroy the terminal object (close the window, free resources	1131	Destroy the terminal object (close the window, free resources
…		…
971		1161
972	Returns true if the option specified by C<$optval> is enabled, and	1162	Returns true if the option specified by C<$optval> is enabled, and
973	optionally change it. All option values are stored by name in the hash	1163	optionally change it. All option values are stored by name in the hash
974	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1164	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
975		1165
976	Here is a a likely non-exhaustive list of option names, please see the	1166	Here is a likely non-exhaustive list of option names, please see the
977	source file F</src/optinc.h> to see the actual list:	1167	source file F</src/optinc.h> to see the actual list:
978		1168
979	borderLess console cursorBlink cursorUnderline hold iconic insecure	1169	borderLess buffered console cursorBlink cursorUnderline hold iconic
980	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1170	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
981	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1171	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
982	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1172	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
983	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1173	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
984	transparent tripleclickwords utmpInhibit visualBell	1174	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1175	urgentOnBell utmpInhibit visualBell
985		1176
986	=item $value = $term->resource ($name[, $newval])	1177	=item $value = $term->resource ($name[, $newval])
987		1178
988	Returns the current resource value associated with a given name and	1179	Returns the current resource value associated with a given name and
989	optionally sets a new value. Setting values is most useful in the C<init>	1180	optionally sets a new value. Setting values is most useful in the C<init>
…		…
998	likely change).	1189	likely change).
999		1190
1000	Please note that resource strings will currently only be freed when the	1191	Please note that resource strings will currently only be freed when the
1001	terminal is destroyed, so changing options frequently will eat memory.	1192	terminal is destroyed, so changing options frequently will eat memory.
1002		1193
1003	Here is a a likely non-exhaustive list of resource names, not all of which	1194	Here is a likely non-exhaustive list of resource names, not all of which
1004	are supported in every build, please see the source file F</src/rsinc.h>	1195	are supported in every build, please see the source file F</src/rsinc.h>
1005	to see the actual list:	1196	to see the actual list:
1006		1197
1007	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1198	answerbackstring backgroundPixmap backspace_key blurradius
1008	borderLess color cursorBlink cursorUnderline cutchars delete_key	1199	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1009	display_name embed ext_bwidth fade font geometry hold iconName	1200	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1010	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1201	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1202	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1011	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1203	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1012	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1204	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1013	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1205	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1014	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1206	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1015	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1207	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1016	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1208	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1017	secondaryScreen secondaryScroll selectstyle shade term_name title	1209	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1018	transient_for transparent transparent_all tripleclickwords utmpInhibit	1210	term_name title transient_for transparent tripleclickwords urgentOnBell
1019	visualBell	1211	utmpInhibit visualBell
1020		1212
1021	=cut	1213	=cut
1022		1214
1023	sub resource($$;$) {	1215	sub resource($$;$) {
1024	my ($self, $name) = (shift, shift);	1216	my ($self, $name) = (shift, shift);
1025	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1217	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1026	&urxvt::term::_resource	1218	goto &urxvt::term::_resource
1027	}	1219	}
1028		1220
1029	=item $value = $term->x_resource ($pattern)	1221	=item $value = $term->x_resource ($pattern)
1030		1222
1031	Returns the X-Resource for the given pattern, excluding the program or	1223	Returns the X-Resource for the given pattern, excluding the program or
1032	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1224	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1033	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1225	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1034	resource with that pattern exists.	1226	resource with that pattern exists.
1035		1227
		1228	Extensions that define extra resource or command line arguments also need
		1229	to call this method to access their values.
		1230
		1231	If the method is called on an extension object (basically, from an
		1232	extension), then the special prefix C<%.> will be replaced by the name of
		1233	the extension and a dot, and the lone string C<%> will be replaced by the
		1234	extension name itself. This makes it possible to code extensions so you
		1235	can rename them and get a new set of commandline switches and resources
		1236	without having to change the actual code.
		1237
1036	This method should only be called during the C<on_start> hook, as there is	1238	This method should only be called during the C<on_start> hook, as there is
1037	only one resource database per display, and later invocations might return	1239	only one resource database per display, and later invocations might return
1038	the wrong resources.	1240	the wrong resources.
1039		1241
1040	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1242	=item $value = $term->x_resource_boolean ($pattern)
1041		1243
		1244	Like C<x_resource>, above, but interprets the string value as a boolean
		1245	and returns C<1> for true values, C<0> for false values and C<undef> if
		1246	the resource or option isn't specified.
		1247
		1248	You should always use this method to parse boolean resources.
		1249
		1250	=cut
		1251
		1252	sub x_resource_boolean {
		1253	my $res = &x_resource;
		1254
		1255	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1256	}
		1257
		1258	=item $success = $term->parse_keysym ($key, $octets)
		1259
1042	Adds a keymap translation exactly as specified via a resource. See the	1260	Adds a key binding exactly as specified via a resource. See the
1043	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1261	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1262
		1263	=item $term->register_command ($keysym, $modifiermask, $string)
		1264
		1265	Adds a key binding. This is a lower level api compared to
		1266	C<parse_keysym>, as it expects a parsed key description, and can be
		1267	used only inside either the C<on_init> hook, to add a binding, or the
		1268	C<on_register_command> hook, to modify a parsed binding.
1044		1269
1045	=item $rend = $term->rstyle ([$new_rstyle])	1270	=item $rend = $term->rstyle ([$new_rstyle])
1046		1271
1047	Return and optionally change the current rendition. Text that is output by	1272	Return and optionally change the current rendition. Text that is output by
1048	the terminal application will use this style.	1273	the terminal application will use this style.
…		…
1056		1281
1057	=item ($row, $col) = $term->selection_beg ([$row, $col])	1282	=item ($row, $col) = $term->selection_beg ([$row, $col])
1058		1283
1059	=item ($row, $col) = $term->selection_end ([$row, $col])	1284	=item ($row, $col) = $term->selection_end ([$row, $col])
1060		1285
1061	Return the current values of the selection mark, begin or end positions,	1286	Return the current values of the selection mark, begin or end positions.
1062	and optionally set them to new values.	1287
		1288	When arguments are given, then the selection coordinates are set to
		1289	C<$row> and C<$col>, and the selection screen is set to the current
		1290	screen.
		1291
		1292	=item $screen = $term->selection_screen ([$screen])
		1293
		1294	Returns the current selection screen, and then optionally sets it.
1063		1295
1064	=item $term->selection_make ($eventtime[, $rectangular])	1296	=item $term->selection_make ($eventtime[, $rectangular])
1065		1297
1066	Tries to make a selection as set by C<selection_beg> and	1298	Tries to make a selection as set by C<selection_beg> and
1067	C<selection_end>. If C<$rectangular> is true (default: false), a	1299	C<selection_end>. If C<$rectangular> is true (default: false), a
1068	rectangular selection will be made. This is the prefered function to make	1300	rectangular selection will be made. This is the preferred function to make
1069	a selection.	1301	a selection.
1070		1302
1071	=item $success = $term->selection_grab ($eventtime)	1303	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1072		1304
1073	Try to request the primary selection text from the server (for example, as	1305	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1306	true) selection from the server. The corresponding text can be set
1074	set by the next method). No visual feedback will be given. This function	1307	with the next method. No visual feedback will be given. This function
1075	is mostly useful from within C<on_sel_grab> hooks.	1308	is mostly useful from within C<on_sel_grab> hooks.
1076		1309
1077	=item $oldtext = $term->selection ([$newtext])	1310	=item $oldtext = $term->selection ([$newtext, $clipboard])
1078		1311
1079	Return the current selection text and optionally replace it by C<$newtext>.	1312	Return the current selection (clipboard if C<$clipboard> is true) text
		1313	and optionally replace it by C<$newtext>.
		1314
		1315	=item $term->selection_clear ([$clipboard])
		1316
		1317	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1080		1318
1081	=item $term->overlay_simple ($x, $y, $text)	1319	=item $term->overlay_simple ($x, $y, $text)
1082		1320
1083	Create a simple multi-line overlay box. See the next method for details.	1321	Create a simple multi-line overlay box. See the next method for details.
1084		1322
…		…
1114		1352
1115	The methods currently supported on C<urxvt::overlay> objects are:	1353	The methods currently supported on C<urxvt::overlay> objects are:
1116		1354
1117	=over 4	1355	=over 4
1118		1356
1119	=item $overlay->set ($x, $y, $text, $rend)	1357	=item $overlay->set ($x, $y, $text[, $rend])
1120		1358
1121	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1359	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1122	text in rxvt-unicode's special encoding and an array of rendition values	1360	text in rxvt-unicode's special encoding and an array of rendition values
1123	at a specific position inside the overlay.	1361	at a specific position inside the overlay.
		1362
		1363	If C<$rend> is missing, then the rendition will not be changed.
1124		1364
1125	=item $overlay->hide	1365	=item $overlay->hide
1126		1366
1127	If visible, hide the overlay, but do not destroy it.	1367	If visible, hide the overlay, but do not destroy it.
1128		1368
…		…
1198		1438
1199	Normally its not a good idea to use this function, as programs might be	1439	Normally its not a good idea to use this function, as programs might be
1200	confused by changes in cursor position or scrolling. Its useful inside a	1440	confused by changes in cursor position or scrolling. Its useful inside a
1201	C<on_add_lines> hook, though.	1441	C<on_add_lines> hook, though.
1202		1442
		1443	=item $term->scr_change_screen ($screen)
		1444
		1445	Switch to given screen - 0 primary, 1 secondary.
		1446
1203	=item $term->cmd_parse ($octets)	1447	=item $term->cmd_parse ($octets)
1204		1448
1205	Similar to C<scr_add_lines>, but the argument must be in the	1449	Similar to C<scr_add_lines>, but the argument must be in the
1206	locale-specific encoding of the terminal and can contain command sequences	1450	locale-specific encoding of the terminal and can contain command sequences
1207	(escape codes) that will be interpreted.	1451	(escape codes) that will be interpreted.
1208		1452
1209	=item $term->tt_write ($octets)	1453	=item $term->tt_write ($octets)
1210		1454
1211	Write the octets given in C<$data> to the tty (i.e. as program input). To	1455	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1212	pass characters instead of octets, you should convert your strings first	1456	pass characters instead of octets, you should convert your strings first
1213	to the locale-specific encoding using C<< $term->locale_encode >>.	1457	to the locale-specific encoding using C<< $term->locale_encode >>.
		1458
		1459	=item $term->tt_paste ($octets)
		1460
		1461	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1462	CR and bracketing the data with control sequences if bracketed paste mode
		1463	is set.
1214		1464
1215	=item $old_events = $term->pty_ev_events ([$new_events])	1465	=item $old_events = $term->pty_ev_events ([$new_events])
1216		1466
1217	Replaces the event mask of the pty watcher by the given event mask. Can	1467	Replaces the event mask of the pty watcher by the given event mask. Can
1218	be used to suppress input and output handling to the pty/tty. See the	1468	be used to suppress input and output handling to the pty/tty. See the
1219	description of C<< urxvt::timer->events >>. Make sure to always restore	1469	description of C<< urxvt::timer->events >>. Make sure to always restore
1220	the previous value.	1470	the previous value.
1221		1471
		1472	=item $fd = $term->pty_fd
		1473
		1474	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1475	is used.
		1476
1222	=item $windowid = $term->parent	1477	=item $windowid = $term->parent
1223		1478
1224	Return the window id of the toplevel window.	1479	Return the window id of the toplevel window.
1225		1480
1226	=item $windowid = $term->vt	1481	=item $windowid = $term->vt
…		…
1232	Adds the specified events to the vt event mask. Useful e.g. when you want	1487	Adds the specified events to the vt event mask. Useful e.g. when you want
1233	to receive pointer events all the times:	1488	to receive pointer events all the times:
1234		1489
1235	$term->vt_emask_add (urxvt::PointerMotionMask);	1490	$term->vt_emask_add (urxvt::PointerMotionMask);
1236		1491
		1492	=item $term->set_urgency ($set)
		1493
		1494	Enable/disable the urgency hint on the toplevel window.
		1495
		1496	=item $term->focus_in
		1497
		1498	=item $term->focus_out
		1499
		1500	=item $term->key_press ($state, $keycode[, $time])
		1501
		1502	=item $term->key_release ($state, $keycode[, $time])
		1503
		1504	Deliver various fake events to to terminal.
		1505
1237	=item $window_width = $term->width	1506	=item $window_width = $term->width
1238		1507
1239	=item $window_height = $term->height	1508	=item $window_height = $term->height
1240		1509
1241	=item $font_width = $term->fwidth	1510	=item $font_width = $term->fwidth
…		…
1271	=item $env = $term->env	1540	=item $env = $term->env
1272		1541
1273	Returns a copy of the environment in effect for the terminal as a hashref	1542	Returns a copy of the environment in effect for the terminal as a hashref
1274	similar to C<\%ENV>.	1543	similar to C<\%ENV>.
1275		1544
		1545	=item @envv = $term->envv
		1546
		1547	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1548
		1549	=item @argv = $term->argv
		1550
		1551	Return the argument vector as this terminal, similar to @ARGV, but
		1552	includes the program name as first element.
		1553
1276	=cut	1554	=cut
1277		1555
1278	sub env {	1556	sub env {
1279	if (my $env = $_[0]->_env) {
1280	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1557	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1281	} else {
1282	+{ %ENV }
1283	}
1284	}	1558	}
1285		1559
1286	=item $modifiermask = $term->ModLevel3Mask	1560	=item $modifiermask = $term->ModLevel3Mask
1287		1561
1288	=item $modifiermask = $term->ModMetaMask	1562	=item $modifiermask = $term->ModMetaMask
1289		1563
1290	=item $modifiermask = $term->ModNumLockMask	1564	=item $modifiermask = $term->ModNumLockMask
1291		1565
1292	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1566	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1293	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1567	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1568
		1569	=item $screen = $term->current_screen
		1570
		1571	Returns the currently displayed screen (0 primary, 1 secondary).
		1572
		1573	=item $cursor_is_hidden = $term->hidden_cursor
		1574
		1575	Returns whether the cursor is currently hidden or not.
1294		1576
1295	=item $view_start = $term->view_start ([$newvalue])	1577	=item $view_start = $term->view_start ([$newvalue])
1296		1578
1297	Returns the row number of the topmost displayed line. Maximum value is	1579	Returns the row number of the topmost displayed line. Maximum value is
1298	C<0>, which displays the normal terminal contents. Lower values scroll	1580	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1306		1588
1307	Used after changing terminal contents to display them.	1589	Used after changing terminal contents to display them.
1308		1590
1309	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1591	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1310		1592
1311	Returns the text of the entire row with number C<$row_number>. Row C<0>	1593	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1312	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1594	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1313	terminal line. The scrollback buffer starts at line C<-1> and extends to
1314	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1595	terminal line. Nothing will be returned if a nonexistent line
1315	is requested.	1596	is requested.
1316		1597
1317	If C<$new_text> is specified, it will replace characters in the current	1598	If C<$new_text> is specified, it will replace characters in the current
1318	line, starting at column C<$start_col> (default C<0>), which is useful	1599	line, starting at column C<$start_col> (default C<0>), which is useful
1319	to replace only parts of a line. The font index in the rendition will	1600	to replace only parts of a line. The font index in the rendition will
1320	automatically be updated.	1601	automatically be updated.
1321		1602
1322	C<$text> is in a special encoding: tabs and wide characters that use more	1603	C<$text> is in a special encoding: tabs and wide characters that use more
1323	than one cell when displayed are padded with urxvt::NOCHAR characters	1604	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1324	(C<chr 65535>). Characters with combining characters and other characters	1605	characters. Characters with combining characters and other characters that
1325	that do not fit into the normal tetx encoding will be replaced with	1606	do not fit into the normal text encoding will be replaced with characters
1326	characters in the private use area.	1607	in the private use area.
1327		1608
1328	You have to obey this encoding when changing text. The advantage is	1609	You have to obey this encoding when changing text. The advantage is
1329	that C<substr> and similar functions work on screen cells and not on	1610	that C<substr> and similar functions work on screen cells and not on
1330	characters.	1611	characters.
1331		1612
…		…
1475	where one character corresponds to one screen cell. See	1756	where one character corresponds to one screen cell. See
1476	C<< $term->ROW_t >> for details.	1757	C<< $term->ROW_t >> for details.
1477		1758
1478	=item $string = $term->special_decode $text	1759	=item $string = $term->special_decode $text
1479		1760
1480	Converts rxvt-unicodes text reprsentation into a perl string. See	1761	Converts rxvt-unicodes text representation into a perl string. See
1481	C<< $term->ROW_t >> for details.	1762	C<< $term->ROW_t >> for details.
1482		1763
1483	=item $success = $term->grab_button ($button, $modifiermask)	1764	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1484		1765
		1766	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1767
1485	Registers a synchronous button grab. See the XGrabButton manpage.	1768	Register/unregister a synchronous button grab. See the XGrabButton
		1769	manpage.
1486		1770
1487	=item $success = $term->grab ($eventtime[, $sync])	1771	=item $success = $term->grab ($eventtime[, $sync])
1488		1772
1489	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1773	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1490	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1774	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1491		1775
1492	=item $term->allow_events_async	1776	=item $term->allow_events_async
1493		1777
1494	Calls XAllowEvents with AsyncBoth for the most recent grab.	1778	Calls XAllowEvents with AsyncBoth for the most recent grab.
1495		1779
…		…
1502	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1786	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1503	recent grab.	1787	recent grab.
1504		1788
1505	=item $term->ungrab	1789	=item $term->ungrab
1506		1790
1507	Calls XUngrab for the most recent grab. Is called automatically on	1791	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1508	evaluation errors, as it is better to lose the grab in the error case as	1792	evaluation errors, as it is better to lose the grab in the error case as
1509	the session.	1793	the session.
		1794
		1795	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1796
		1797	=item $atom_name = $term->XGetAtomName ($atom)
		1798
		1799	=item @atoms = $term->XListProperties ($window)
		1800
		1801	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1802
		1803	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1804
		1805	=item $term->XDeleteProperty ($window, $property)
		1806
		1807	=item $window = $term->DefaultRootWindow
		1808
		1809	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1810
		1811	=item $term->XMapWindow ($window)
		1812
		1813	=item $term->XUnmapWindow ($window)
		1814
		1815	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1816
		1817	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1818
		1819	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1820
		1821	=item $keysym = $term->XStringToKeysym ($string)
		1822
		1823	=item $string = $term->XKeysymToString ($keysym)
		1824
		1825	Various X or X-related functions. The C<$term> object only serves as
		1826	the source of the display, otherwise those functions map more-or-less
		1827	directly onto the X functions of the same name.
1510		1828
1511	=back	1829	=back
1512		1830
1513	=cut	1831	=cut
1514		1832
…		…
1578	my ($self, $text, $cb) = @_;	1896	my ($self, $text, $cb) = @_;
1579		1897
1580	$self->add_item ({ type => "button", text => $text, activate => $cb});	1898	$self->add_item ({ type => "button", text => $text, activate => $cb});
1581	}	1899	}
1582		1900
1583	=item $popup->add_toggle ($text, $cb, $initial_value)	1901	=item $popup->add_toggle ($text, $initial_value, $cb)
1584		1902
1585	Adds a toggle/checkbox item to the popup. Teh callback gets called	1903	Adds a toggle/checkbox item to the popup. The callback gets called
1586	whenever it gets toggled, with a boolean indicating its value as its first	1904	whenever it gets toggled, with a boolean indicating its new value as its
1587	argument.	1905	first argument.
1588		1906
1589	=cut	1907	=cut
1590		1908
1591	sub add_toggle {	1909	sub add_toggle {
1592	my ($self, $text, $cb, $value) = @_;	1910	my ($self, $text, $value, $cb) = @_;
1593		1911
1594	my $item; $item = {	1912	my $item; $item = {
1595	type => "button",	1913	type => "button",
1596	text => " $text",	1914	text => " $text",
1597	value => $value,	1915	value => $value,
…		…
1616	my $env = $self->{term}->env;	1934	my $env = $self->{term}->env;
1617	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1935	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1618	delete $env->{LC_ALL};	1936	delete $env->{LC_ALL};
1619	$env->{LC_CTYPE} = $self->{term}->locale;	1937	$env->{LC_CTYPE} = $self->{term}->locale;
1620		1938
1621	urxvt::term->new ($env, "popup",	1939	my $term = urxvt::term->new (
		1940	$env, "popup",
1622	"--perl-lib" => "", "--perl-ext-common" => "",	1941	"--perl-lib" => "", "--perl-ext-common" => "",
1623	"-pty-fd" => -1, "-sl" => 0,	1942	"-pty-fd" => -1, "-sl" => 0,
1624	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1943	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1625	"--transient-for" => $self->{term}->parent,	1944	"--transient-for" => $self->{term}->parent,
1626	"-display" => $self->{term}->display_id,	1945	"-display" => $self->{term}->display_id,
1627	"-pe" => "urxvt-popup")	1946	"-pe" => "urxvt-popup",
1628	or die "unable to create popup window\n";	1947	) or die "unable to create popup window\n";
		1948
		1949	unless (delete $term->{urxvt_popup_init_done}) {
		1950	$term->ungrab;
		1951	$term->destroy;
		1952	die "unable to initialise popup window\n";
		1953	}
1629	}	1954	}
1630		1955
1631	sub DESTROY {	1956	sub DESTROY {
1632	my ($self) = @_;	1957	my ($self) = @_;
1633		1958
1634	delete $self->{term}{_destroy}{$self};	1959	delete $self->{term}{_destroy}{$self};
1635	$self->{term}->ungrab;	1960	$self->{term}->ungrab;
1636	}	1961	}
1637		1962
1638	=back	1963	=back
		1964
		1965	=cut
		1966
		1967	package urxvt::watcher;
1639		1968
1640	=head2 The C<urxvt::timer> Class	1969	=head2 The C<urxvt::timer> Class
1641		1970
1642	This class implements timer watchers/events. Time is represented as a	1971	This class implements timer watchers/events. Time is represented as a
1643	fractional number of seconds since the epoch. Example:	1972	fractional number of seconds since the epoch. Example:
…		…
1647	->new	1976	->new
1648	->interval (1)	1977	->interval (1)
1649	->cb (sub {	1978	->cb (sub {
1650	$term->{overlay}->set (0, 0,	1979	$term->{overlay}->set (0, 0,
1651	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1980	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1652	});	1981	});
1653		1982
1654	=over 4	1983	=over 4
1655		1984
1656	=item $timer = new urxvt::timer	1985	=item $timer = new urxvt::timer
1657		1986
…		…
1660		1989
1661	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1990	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1662		1991
1663	Set the callback to be called when the timer triggers.	1992	Set the callback to be called when the timer triggers.
1664		1993
1665	=item $tstamp = $timer->at
1666
1667	Return the time this watcher will fire next.
1668
1669	=item $timer = $timer->set ($tstamp)	1994	=item $timer = $timer->set ($tstamp[, $interval])
1670		1995
1671	Set the time the event is generated to $tstamp.	1996	Set the time the event is generated to $tstamp (and optionally specifies a
		1997	new $interval).
1672		1998
1673	=item $timer = $timer->interval ($interval)	1999	=item $timer = $timer->interval ($interval)
1674		2000
1675	Normally (and when C<$interval> is C<0>), the timer will automatically	2001	By default (and when C<$interval> is C<0>), the timer will automatically
1676	stop after it has fired once. If C<$interval> is non-zero, then the timer	2002	stop after it has fired once. If C<$interval> is non-zero, then the timer
1677	is automatically rescheduled at the given intervals.	2003	is automatically rescheduled at the given intervals.
1678		2004
1679	=item $timer = $timer->start	2005	=item $timer = $timer->start
1680		2006
1681	Start the timer.	2007	Start the timer.
1682		2008
1683	=item $timer = $timer->start ($tstamp)	2009	=item $timer = $timer->start ($tstamp[, $interval])
1684		2010
1685	Set the event trigger time to C<$tstamp> and start the timer.	2011	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2012	also replaces the interval.
1686		2013
1687	=item $timer = $timer->after ($delay)	2014	=item $timer = $timer->after ($delay[, $interval])
1688		2015
1689	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2016	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1690		2017
1691	=item $timer = $timer->stop	2018	=item $timer = $timer->stop
1692		2019
…		…
1700		2027
1701	$term->{socket} = ...	2028	$term->{socket} = ...
1702	$term->{iow} = urxvt::iow	2029	$term->{iow} = urxvt::iow
1703	->new	2030	->new
1704	->fd (fileno $term->{socket})	2031	->fd (fileno $term->{socket})
1705	->events (urxvt::EVENT_READ)	2032	->events (urxvt::EV_READ)
1706	->start	2033	->start
1707	->cb (sub {	2034	->cb (sub {
1708	my ($iow, $revents) = @_;	2035	my ($iow, $revents) = @_;
1709	# $revents must be 1 here, no need to check	2036	# $revents must be 1 here, no need to check
1710	sysread $term->{socket}, my $buf, 8192	2037	sysread $term->{socket}, my $buf, 8192
…		…
1723	Set the callback to be called when io events are triggered. C<$reventmask>	2050	Set the callback to be called when io events are triggered. C<$reventmask>
1724	is a bitset as described in the C<events> method.	2051	is a bitset as described in the C<events> method.
1725		2052
1726	=item $iow = $iow->fd ($fd)	2053	=item $iow = $iow->fd ($fd)
1727		2054
1728	Set the filedescriptor (not handle) to watch.	2055	Set the file descriptor (not handle) to watch.
1729		2056
1730	=item $iow = $iow->events ($eventmask)	2057	=item $iow = $iow->events ($eventmask)
1731		2058
1732	Set the event mask to watch. The only allowed values are	2059	Set the event mask to watch. The only allowed values are
1733	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2060	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1734	together, or C<urxvt::EVENT_NONE>.	2061	together, or C<urxvt::EV_NONE>.
1735		2062
1736	=item $iow = $iow->start	2063	=item $iow = $iow->start
1737		2064
1738	Start watching for requested events on the given handle.	2065	Start watching for requested events on the given handle.
1739		2066
1740	=item $iow = $iow->stop	2067	=item $iow = $iow->stop
1741		2068
1742	Stop watching for events on the given filehandle.	2069	Stop watching for events on the given file handle.
		2070
		2071	=back
		2072
		2073	=head2 The C<urxvt::iw> Class
		2074
		2075	This class implements idle watchers, that get called automatically when
		2076	the process is idle. They should return as fast as possible, after doing
		2077	some useful work.
		2078
		2079	=over 4
		2080
		2081	=item $iw = new urxvt::iw
		2082
		2083	Create a new idle watcher object in stopped state.
		2084
		2085	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2086
		2087	Set the callback to be called when the watcher triggers.
		2088
		2089	=item $timer = $timer->start
		2090
		2091	Start the watcher.
		2092
		2093	=item $timer = $timer->stop
		2094
		2095	Stop the watcher.
		2096
		2097	=back
		2098
		2099	=head2 The C<urxvt::pw> Class
		2100
		2101	This class implements process watchers. They create an event whenever a
		2102	process exits, after which they stop automatically.
		2103
		2104	my $pid = fork;
		2105	...
		2106	$term->{pw} = urxvt::pw
		2107	->new
		2108	->start ($pid)
		2109	->cb (sub {
		2110	my ($pw, $exit_status) = @_;
		2111	...
		2112	});
		2113
		2114	=over 4
		2115
		2116	=item $pw = new urxvt::pw
		2117
		2118	Create a new process watcher in stopped state.
		2119
		2120	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2121
		2122	Set the callback to be called when the timer triggers.
		2123
		2124	=item $pw = $timer->start ($pid)
		2125
		2126	Tells the watcher to start watching for process C<$pid>.
		2127
		2128	=item $pw = $pw->stop
		2129
		2130	Stop the watcher.
1743		2131
1744	=back	2132	=back
1745		2133
1746	=head1 ENVIRONMENT	2134	=head1 ENVIRONMENT
1747		2135
…		…
1756		2144
1757	=item >= 3 - script loading and management	2145	=item >= 3 - script loading and management
1758		2146
1759	=item >=10 - all called hooks	2147	=item >=10 - all called hooks
1760		2148
1761	=item >=11 - hook reutrn values	2149	=item >=11 - hook return values
1762		2150
1763	=back	2151	=back
1764		2152
1765	=head1 AUTHOR	2153	=head1 AUTHOR
1766		2154
1767	Marc Lehmann <pcg@goof.com>	2155	Marc Lehmann <schmorp@schmorp.de>
1768	http://software.schmorp.de/pkg/rxvt-unicode	2156	http://software.schmorp.de/pkg/rxvt-unicode
1769		2157
1770	=cut	2158	=cut
1771		2159
1772	1	2160	1
		2161
		2162	# vim: sw=3:

Diff Legend

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