ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

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

Diff Legend

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