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.109 by root, Thu Jan 19 16:07:09 2006 UTC vs.
Revision 1.236 by root, Sat May 17 17:12:29 2014 UTC

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

Diff Legend

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