[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC vs. Revision 1.237 by root, Sun May 18 18:09:52 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC vs.
Revision 1.237 by root, Sun May 18 18:09:52 2014 UTC