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.115 by root, Fri Jan 20 15:57:21 2006 UTC vs.
Revision 1.238 by root, Sun May 18 18:15:04 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	evalution, 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 Shift-Left and
175	Shift-Right will switch to the tab left or right of the current one.
176
177	=item mark-urls
178
179	Uses per-line display filtering (C<on_line_update>) to underline urls and
180	make them clickable. When middle-clicked, the program specified in the
181	resource C<urlLauncher> (default C<x-www-browser>) will be started with
182	the URL as first argument.
183
184	=item automove-background
185
186	This is basically a one-line extension that dynamically changes the background pixmap offset
187	to the window position, in effect creating the same effect as pseudo transparency with
188	a custom pixmap. No scaling is supported in this mode. Exmaple:
189
190	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
191
192	=item block-graphics-to-ascii
193
194	A not very useful example of filtering all text output to the terminal,
195	by replacing all line-drawing characters (U+2500 .. U+259F) by a
196	similar-looking ascii character.
197
198	=item digital-clock
199
200	Displays a digital clock using the built-in overlay.
201
202	=item example-refresh-hooks
203
204	Displays a very simple digital clock in the upper right corner of the
205	window. Illustrates overwriting the refresh callbacks to create your own
206	overlays or changes.
207
208	=item selection-pastebin
209
210	This is a little rarely useful extension that Uploads the selection as
211	textfile to a remote site (or does other things). (The implementation is
212	not currently secure for use in a multiuser environment as it writes to
213	F</tmp> directly.).
214
215	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
216	i.e.
217
218	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
219
220	Pressing this combination runs a command with C<%> replaced by the name of
221	the textfile. This command can be set via a resource:
222
223	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
224
225	And the default is likely not useful to anybody but the few people around
226	here :)
227
228	The name of the textfile is the hex encoded md5 sum of the selection, so
229	the same content should lead to the same filename.
230
231	After a successful upload the selection will be replaced by the text given
232	in the C<selection-pastebin-url> resource (again, the % is the placeholder
233	for the filename):
234
235	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
236
237	=back
238		50
239	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
240		52
241	=head2 General API Considerations	53	=head2 General API Considerations
242		54
…		…
256		68
257	=over 4	69	=over 4
258		70
259	=item $text	71	=item $text
260		72
261	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
262	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.
263		75
264	=item $string	76	=item $string
265		77
266	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
…		…
270	=item $octets	82	=item $octets
271		83
272	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
273	locale-specific way.	85	locale-specific way.
274		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
275	=back	93	=back
276		94
277	=head2 Extension Objects	95	=head2 Extension Objects
278		96
279	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
280	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,
281	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
282	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
283	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
284	use.	103	internal use.
285		104
286	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
287	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
288		107
289	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
290		109	the C<urxvt::extension> section below.
291	=over 4
292
293	=item $urxvt_term = $self->{term}
294
295	Returns the C<urxvt::term> object associated with this instance of the
296	extension. This member I<must not> be changed in any way.
297
298	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
299
300	Dynamically enable the given hooks (named without the C<on_> prefix) for
301	this extension, replacing any previous hook. This is useful when you want
302	to overwrite time-critical hooks only temporarily.
303
304	=item $self->disable ($hook_name[, $hook_name..])
305
306	Dynamically disable the given hooks.
307
308	=back
309		110
310	=head2 Hooks	111	=head2 Hooks
311		112
312	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
313	called whenever the relevant event happens.	114	called whenever the relevant event happens.
314		115
315	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
316	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
317		118
318	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
319	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
320	relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
…		…
333	place.	134	place.
334		135
335	=item on_start $term	136	=item on_start $term
336		137
337	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
338	trying to map (display) the toplevel and returning to the mainloop.	139	trying to map (display) the toplevel and returning to the main loop.
339		140
340	=item on_destroy $term	141	=item on_destroy $term
341		142
342	Called whenever something tries to destroy terminal, before doing anything	143	Called whenever something tries to destroy terminal, when the terminal is
343	yet. If this hook returns true, then destruction is skipped, but this is	144	still fully functional (not for long, though).
344	rarely a good idea.
345		145
346	=item on_reset $term	146	=item on_reset $term
347		147
348	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
349	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
…		…
371		171
372	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
373	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
374	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
375		175
376	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.
377		177
378	=item on_sel_extend $term	178	=item on_sel_extend $term
379		179
380	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
381	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
382	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
383	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
384	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
385	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
386		186
387	See the F<selection> example extension.	187	See the F<selection> example extension.
388		188
389	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
390		190
391	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
392	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
393	show this many lines of scrollback.	193	show this many lines of scrollback.
394		194
395	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
396		196
…		…
400		200
401	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,
402	$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
403	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
404		204
405	=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
406		216
407	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
408	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
409	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
410	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,
411	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
412	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	}
413		233
414	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,
415	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
416	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.
417		240
418	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
419		242
420	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
421	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
…		…
426	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
427		250
428	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
429	suppress or filter tty input.	252	suppress or filter tty input.
430		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
431	=item on_line_update $term, $row	261	=item on_line_update $term, $row
432		262
433	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
434	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
435	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,
…		…
442	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
443	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
444		274
445	=item on_refresh_begin $term	275	=item on_refresh_begin $term
446		276
447	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
448	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
449	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
450	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
451		281
452	=item on_refresh_end $term	282	=item on_refresh_end $term
453		283
454	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>.
455		285
456	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
457		287
458	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
459	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>
460	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.
461		300
462	=item on_x_event $term, $event	301	=item on_x_event $term, $event
463		302
464	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
465	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
466	members are not passed.	305	members are not passed.
467		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
468	=item on_focus_in $term	311	=item on_focus_in $term
469		312
470	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
471	does focus in processing.	314	does focus in processing.
472		315
473	=item on_focus_out $term	316	=item on_focus_out $term
474		317
475	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
476	focus out processing.	319	focus out processing.
477		320
478	=item on_configure_notify $term, $event	321	=item on_configure_notify $term, $event
479		322
		323	=item on_property_notify $term, $event
		324
480	=item on_key_press $term, $event, $keysym, $octets	325	=item on_key_press $term, $event, $keysym, $octets
481		326
482	=item on_key_release $term, $event, $keysym	327	=item on_key_release $term, $event, $keysym
483		328
484	=item on_button_press $term, $event	329	=item on_button_press $term, $event
…		…
489		334
490	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
491		336
492	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
493		338
494	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
495	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.
496		341
497	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
498	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
499	and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
500		345
501	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
502	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
503		348
504	subwindow.
505
506	=item on_client_message $term, $event	349	=item on_client_message $term, $event
507		350
508	=item on_wm_protocols $term, $event	351	=item on_wm_protocols $term, $event
509		352
510	=item on_wm_delete_window $term, $event	353	=item on_wm_delete_window $term, $event
511		354
512	Called when various types of ClientMessage events are received (all with	355	Called when various types of ClientMessage events are received (all with
513	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	356	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
514		357
		358	=item on_bell $term
		359
		360	Called on receipt of a bell character.
		361
515	=back	362	=back
516		363
517	=cut	364	=cut
518		365
519	package urxvt;	366	package urxvt;
520		367
521	use utf8;	368	use utf8;
522	use strict;	369	use strict 'vars';
523	use Carp ();	370	use Carp ();
524	use Scalar::Util ();	371	use Scalar::Util ();
525	use List::Util ();	372	use List::Util ();
526		373
527	our $VERSION = 1;	374	our $VERSION = 1;
528	our $TERM;	375	our $TERM;
529	our @TERM_INIT;	376	our @TERM_INIT; # should go, prevents async I/O etc.
530	our @TERM_EXT;	377	our @TERM_EXT; # should go, prevents async I/O etc.
531	our @HOOKNAME;	378	our @HOOKNAME;
532	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
533	our %OPTION;	380	our %OPTION;
534		381
535	our $LIBDIR;	382	our $LIBDIR;
536	our $RESNAME;	383	our $RESNAME;
537	our $RESCLASS;	384	our $RESCLASS;
538	our $RXVTNAME;	385	our $RXVTNAME;
539		386
		387	our $NOCHAR = chr 0xffff;
		388
540	=head2 Variables in the C<urxvt> Package	389	=head2 Variables in the C<urxvt> Package
541		390
542	=over 4	391	=over 4
543		392
544	=item $urxvt::LIBDIR	393	=item $urxvt::LIBDIR
…		…
559	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
560	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
561		410
562	=item @urxvt::TERM_INIT	411	=item @urxvt::TERM_INIT
563		412
564	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
565	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
566	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,
567	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.
568		417
569	This complements to the perl-eval commandline option, but gets executed	418	This complements to the perl-eval command line option, but gets executed
570	first.	419	first.
571		420
572	=item @urxvt::TERM_EXT	421	=item @urxvt::TERM_EXT
573		422
574	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
…		…
581		430
582	=over 4	431	=over 4
583		432
584	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
585		434
586	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
587	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
588	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
589		439
590	=item urxvt::warn $string	440	=item urxvt::warn $string
591		441
592	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
593	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
594	that calls this function.	444	that calls this function.
595		445
596	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
597	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
598		448
599	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).
600		457
601	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
602		459
603	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
604		461
…		…
647		504
648	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
649		506
650	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
651		508
652	=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
653		511
654	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
655	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
656	the bitset.	514	the bitset.
657		515
…		…
662	Return the foreground/background colour index, respectively.	520	Return the foreground/background colour index, respectively.
663		521
664	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	522	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
665		523
666	=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
667		527
668	Replace the foreground/background colour in the rendition mask with the	528	Replace the foreground/background colour in the rendition mask with the
669	specified one.	529	specified one.
670		530
671	=item $value = urxvt::GET_CUSTOM $rend	531	=item $value = urxvt::GET_CUSTOM $rend
…		…
690	unless $msg =~ /\n$/;	550	unless $msg =~ /\n$/;
691	urxvt::warn ($msg);	551	urxvt::warn ($msg);
692	};	552	};
693	}	553	}
694		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
695	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
696		618
697	sub verbose {	619	sub verbose {
698	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
699	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
…		…
711	$pkg =~ s/[^[:word:]]/_/g;	633	$pkg =~ s/[^[:word:]]/_/g;
712	$pkg = "urxvt::ext::$pkg";	634	$pkg = "urxvt::ext::$pkg";
713		635
714	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
715		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		639
716	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
717	or die "$path: $!";	641	or die "$path: $!";
718		642
719	my $source =	643	my $source =
720	"package $pkg; use strict; use utf8;\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
721	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
722	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
723	. "\n};\n1";	647	. "\n};\n1";
724		648
725	eval $source	649	eval $source
…		…
734	# called by the rxvt core	658	# called by the rxvt core
735	sub invoke {	659	sub invoke {
736	local $TERM = shift;	660	local $TERM = shift;
737	my $htype = shift;	661	my $htype = shift;
738		662
739	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
740	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
741		665
		666	$TERM->scan_extensions;
		667
742	my %ext_arg;	668	my %ext_arg;
743		669
744	{	670	{
745	my @init = @TERM_INIT;	671	my @init = @TERM_INIT;
746	@TERM_INIT = ();	672	@TERM_INIT = ();
…		…
748	my @pkg = @TERM_EXT;	674	my @pkg = @TERM_EXT;
749	@TERM_EXT = ();	675	@TERM_EXT = ();
750	$TERM->register_package ($_) for @pkg;	676	$TERM->register_package ($_) for @pkg;
751	}	677	}
752		678
		679	for (
753	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	680	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		681	) {
754	if ($_ eq "default") {	682	if ($_ eq "default") {
755	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	683
		684	$ext_arg{$_} = []
		685	for
		686	qw(selection option-popup selection-popup readline),
		687	map $_->[0], values %{ $TERM->{meta}{binding} },
		688	@{ delete $TERM->{perl_ext_3} };
		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
756	} elsif (/^-(.*)$/) {	700	} elsif (/^-(.*)$/) {
757	delete $ext_arg{$1};	701	delete $ext_arg{$1};
		702
758	} elsif (/^([^<]+)<(.*)>$/) {	703	} elsif (/^([^<]+)<(.*)>$/) {
759	push @{ $ext_arg{$1} }, $2;	704	push @{ $ext_arg{$1} }, $2;
		705
760	} else {	706	} else {
761	$ext_arg{$_} ||= [];	707	$ext_arg{$_} ||= [];
762	}	708	}
763	}	709	}
764		710
765	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) {
766	my @files = grep -f $_, map "$_/$ext", @dirs;	719	my @files = grep -f $_, map "$_/$ext", @dirs;
767		720
768	if (@files) {	721	if (@files) {
769	$TERM->register_package (extension_package $files[0], $argv);	722	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
770	} else {	723	} else {
771	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";
772	}	725	}
773	}	726	}
774		727
…		…
780		733
781	if (my $cb = $TERM->{_hook}[$htype]) {	734	if (my $cb = $TERM->{_hook}[$htype]) {
782	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	735	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
783	if $verbosity >= 10;	736	if $verbosity >= 10;
784		737
785	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";
786		744
787	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) {
788	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	752	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
789	$retval ||= $retval_;	753	$retval ||= $retval_;
790		754
791	if ($@) {	755	if ($@) {
792	$TERM->ungrab; # better to lose the grab than the session	756	$TERM->ungrab; # better to lose the grab than the session
793	warn $@;	757	warn $@;
…		…
796		760
797	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	761	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
798	if $verbosity >= 11;	762	if $verbosity >= 11;
799	}	763	}
800		764
801	if ($htype == 1) { # DESTROY	765	if ($htype == HOOK_DESTROY) {
802	# clear package objects	766	# clear package objects
803	%$_ = () for values %{ $TERM->{_pkg} };	767	%$_ = () for values %{ $TERM->{_pkg} };
804		768
805	# clear package	769	# clear package
806	%$TERM = ();	770	%$TERM = ();
807	}	771	}
808		772
809	$retval	773	$retval
810	}	774	}
811		775
812	# urxvt::term::extension	776	sub SET_COLOR($$$) {
		777	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		778	}
		779
		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	}
813		804
814	package urxvt::term::extension;	805	package urxvt::term::extension;
815		806
816	sub enable {	807	=head2 The C<urxvt::term::extension> class
817	my ($self, %hook) = @_;
818	my $pkg = $self->{_pkg};
819		808
820	while (my ($name, $cb) = each %hook) {	809	Each extension attached to a terminal object is represented by
821	my $htype = $HOOKTYPE{uc $name};	810	a C<urxvt::term::extension> object.
822	defined $htype
823	or Carp::croak "unsupported hook type '$name'";
824		811
825	$self->set_should_invoke ($htype, +1)	812	You can use these objects, which are passed to all callbacks to store any
826	unless exists $self->{term}{_hook}[$htype]{$pkg};	813	state related to the terminal and extension instance.
827		814
828	$self->{term}{_hook}[$htype]{$pkg} = $cb;	815	The methods (And data members) documented below can be called on extension
829	}	816	objects, in addition to call methods documented for the <urxvt::term>
830	}	817	class.
831		818
832	sub disable {	819	=over 4
833	my ($self, @hook) = @_;
834	my $pkg = $self->{_pkg};
835		820
836	for my $name (@hook) {	821	=item $urxvt_term = $self->{term}
837	my $htype = $HOOKTYPE{uc $name};
838	defined $htype
839	or Carp::croak "unsupported hook type '$name'";
840		822
841	$self->set_should_invoke ($htype, -1)	823	Returns the C<urxvt::term> object associated with this instance of the
842	if delete $self->{term}{_hook}[$htype]{$pkg};	824	extension. This member I<must not> be changed in any way.
843	}	825
844	}	826	=cut
845		827
846	our $AUTOLOAD;	828	our $AUTOLOAD;
847		829
848	sub AUTOLOAD {	830	sub AUTOLOAD {
849	$AUTOLOAD =~ /:([^:]+)$/	831	$AUTOLOAD =~ /:([^:]+)$/
…		…
862		844
863	sub DESTROY {	845	sub DESTROY {
864	# nop	846	# nop
865	}	847	}
866		848
867	# urxvt::destroy_hook	849	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
868		850
869	sub urxvt::destroy_hook::DESTROY {	851	sub urxvt::destroy_hook::DESTROY {
870	${$_[0]}->();	852	${$_[0]}->();
871	}	853	}
872		854
873	sub urxvt::destroy_hook(&) {	855	sub urxvt::destroy_hook(&) {
874	bless \shift, urxvt::destroy_hook::	856	bless \shift, urxvt::destroy_hook::
875	}	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
876		972
877	package urxvt::anyevent;	973	package urxvt::anyevent;
878		974
879	=head2 The C<urxvt::anyevent> Class	975	=head2 The C<urxvt::anyevent> Class
880		976
881	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
882	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
883	further programming. The only exception is that you cannot wait on	979	further programming. The only exception is that you cannot wait on
884	condition variables, but non-blocking condvar use is ok. What this means	980	condition variables, but non-blocking condvar use is ok.
885	is that you cannot use blocking APIs, but the non-blocking variant should
886	work.
887		981
888	=cut	982	In practical terms this means is that you cannot use blocking APIs, but
		983	the non-blocking variant should work.
889		984
		985	=cut
		986
890	our $VERSION = 1;	987	our $VERSION = '5.23';
891		988
892	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	989	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
893	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	990	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
894		991
895	sub timer {	992	sub timer {
…		…
897		994
898	my $cb = $arg{cb};	995	my $cb = $arg{cb};
899		996
900	urxvt::timer	997	urxvt::timer
901	->new	998	->new
902	->start (urxvt::NOW + $arg{after})	999	->after ($arg{after}, $arg{interval})
903	->cb (sub {	1000	->cb ($arg{interval} ? $cb : sub {
904	$_[0]->stop; # need to cancel manually	1001	$_[0]->stop; # need to cancel manually
905	$cb->();	1002	$cb->();
906	})	1003	})
907	}	1004	}
908		1005
909	sub io {	1006	sub io {
910	my ($class, %arg) = @_;	1007	my ($class, %arg) = @_;
911		1008
912	my $cb = $arg{cb};	1009	my $cb = $arg{cb};
		1010	my $fd = fileno $arg{fh};
		1011	defined $fd or $fd = $arg{fh};
913		1012
914	bless [$arg{fh}, urxvt::iow	1013	bless [$arg{fh}, urxvt::iow
915	->new	1014	->new
916	->fd (fileno $arg{fh})	1015	->fd ($fd)
917	->events (($arg{poll} =~ /r/ ? 1 : 0)	1016	->events (($arg{poll} =~ /r/ ? 1 : 0)
918	| ($arg{poll} =~ /w/ ? 2 : 0))	1017	| ($arg{poll} =~ /w/ ? 2 : 0))
919	->start	1018	->start
920	->cb (sub {	1019	->cb ($cb)
921	$cb->(($_[1] & 1 ? 'r' : '')
922	. ($_[1] & 2 ? 'w' : ''));
923	})],
924	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	})
925	}	1046	}
926		1047
927	sub DESTROY {	1048	sub DESTROY {
928	$_[0][1]->stop;	1049	$_[0][1]->stop;
929	}	1050	}
930		1051
931	sub condvar {	1052	# only needed for AnyEvent < 6 compatibility
932	bless \my $flag, urxvt::anyevent::condvar::	1053	sub one_event {
933	}
934
935	sub urxvt::anyevent::condvar::broadcast {
936	${$_[0]}++;
937	}
938
939	sub urxvt::anyevent::condvar::wait {
940	unless (${$_[0]}) {
941	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";
942	}
943	}	1055	}
944		1056
945	package urxvt::term;	1057	package urxvt::term;
946		1058
947	=head2 The C<urxvt::term> Class	1059	=head2 The C<urxvt::term> Class
…		…
960	urxvt::verbose 6, "register package $pkg to $self";	1072	urxvt::verbose 6, "register package $pkg to $self";
961		1073
962	@{"$pkg\::ISA"} = urxvt::term::extension::;	1074	@{"$pkg\::ISA"} = urxvt::term::extension::;
963		1075
964	my $proxy = bless {	1076	my $proxy = bless {
965	_pkg => $pkg,	1077	_pkg => $pkg,
		1078	_name => ${"$pkg\::_NAME"}, # hackish
966	argv => $argv,	1079	argv => $argv,
967	}, $pkg;	1080	}, $pkg;
968	Scalar::Util::weaken ($proxy->{term} = $self);	1081	Scalar::Util::weaken ($proxy->{term} = $self);
969		1082
970	$self->{_pkg}{$pkg} = $proxy;	1083	$self->{_pkg}{$pkg} = $proxy;
971		1084
…		…
974	$proxy->enable ($name => $ref);	1087	$proxy->enable ($name => $ref);
975	}	1088	}
976	}	1089	}
977	}	1090	}
978		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
979	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1155	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
980		1156
981	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
982	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
983	hash which defines the environment of the new terminal.	1159	hash which defines the environment of the new terminal.
984		1160
985	Croaks (and probably outputs an error message) if the new instance	1161	Croaks (and probably outputs an error message) if the new instance
986	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
987	initialise perl, and the terminal object otherwise. The C<init> and	1163	initialise perl, and the terminal object otherwise. The C<init> and
988	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).
989		1166
990	=cut	1167	=cut
991		1168
992	sub new {	1169	sub new {
993	my ($class, $env, @args) = @_;	1170	my ($class, $env, @args) = @_;
994		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
995	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1175	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
996	}	1176	}
997		1177
998	=item $term->destroy	1178	=item $term->destroy
999		1179
1000	Destroy the terminal object (close the window, free resources	1180	Destroy the terminal object (close the window, free resources
1001	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
1002	watchers (timers, io watchers) are still active.	1182	watchers (timers, io watchers) are still active.
1003		1183
1004	=item $term->exec_async ($cmd[, @args])	1184	=item $term->exec_async ($cmd[, @args])
1005		1185
1006	Works like the combination of the C<fork>/C<exec> builtins, which executes	1186	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1030		1210
1031	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
1032	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
1033	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.
1034		1214
1035	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
1036	source file F</src/optinc.h> to see the actual list:	1216	source file F</src/optinc.h> to see the actual list:
1037		1217
1038	borderLess console cursorBlink cursorUnderline hold iconic insecure	1218	borderLess buffered console cursorBlink cursorUnderline hold iconic
1039	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1219	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1040	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1220	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1041	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1221	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1042	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1222	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1043	transparent tripleclickwords utmpInhibit visualBell	1223	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1224	urgentOnBell utmpInhibit visualBell
1044		1225
1045	=item $value = $term->resource ($name[, $newval])	1226	=item $value = $term->resource ($name[, $newval])
1046		1227
1047	Returns the current resource value associated with a given name and	1228	Returns the current resource value associated with a given name and
1048	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>
…		…
1057	likely change).	1238	likely change).
1058		1239
1059	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
1060	terminal is destroyed, so changing options frequently will eat memory.	1241	terminal is destroyed, so changing options frequently will eat memory.
1061		1242
1062	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
1063	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>
1064	to see the actual list:	1245	to see the actual list:
1065		1246
1066	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1247	answerbackstring backgroundPixmap backspace_key blurradius
1067	borderLess color cursorBlink cursorUnderline cutchars delete_key	1248	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1068	display_name embed ext_bwidth fade font geometry hold iconName	1249	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1069	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
1070	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1252	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1071	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1253	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1072	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1254	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1073	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1255	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1074	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1256	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1075	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1257	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1076	secondaryScreen secondaryScroll selectstyle shade term_name title	1258	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1077	transient_for transparent transparent_all tripleclickwords utmpInhibit	1259	term_name title transient_for transparent tripleclickwords urgentOnBell
1078	visualBell	1260	utmpInhibit visualBell
1079		1261
1080	=cut	1262	=cut
1081		1263
1082	sub resource($$;$) {	1264	sub resource($$;$) {
1083	my ($self, $name) = (shift, shift);	1265	my ($self, $name) = (shift, shift);
1084	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1266	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1085	&urxvt::term::_resource	1267	goto &urxvt::term::_resource
1086	}	1268	}
1087		1269
1088	=item $value = $term->x_resource ($pattern)	1270	=item $value = $term->x_resource ($pattern)
1089		1271
1090	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
1091	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
1092	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
1093	resource with that pattern exists.	1275	resource with that pattern exists.
1094		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
1095	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
1096	only one resource database per display, and later invocations might return	1288	only one resource database per display, and later invocations might return
1097	the wrong resources.	1289	the wrong resources.
1098		1290
1099	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1291	=item $value = $term->x_resource_boolean ($pattern)
1100		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
1101	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
1102	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1310	C<keysym> resource in the urxvt(1) manpage.
1103		1311
1104	=item $rend = $term->rstyle ([$new_rstyle])	1312	=item $rend = $term->rstyle ([$new_rstyle])
1105		1313
1106	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
1107	the terminal application will use this style.	1315	the terminal application will use this style.
…		…
1115		1323
1116	=item ($row, $col) = $term->selection_beg ([$row, $col])	1324	=item ($row, $col) = $term->selection_beg ([$row, $col])
1117		1325
1118	=item ($row, $col) = $term->selection_end ([$row, $col])	1326	=item ($row, $col) = $term->selection_end ([$row, $col])
1119		1327
1120	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.
1121	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.
1122		1337
1123	=item $term->selection_make ($eventtime[, $rectangular])	1338	=item $term->selection_make ($eventtime[, $rectangular])
1124		1339
1125	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
1126	C<selection_end>. If C<$rectangular> is true (default: false), a	1341	C<selection_end>. If C<$rectangular> is true (default: false), a
1127	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
1128	a selection.	1343	a selection.
1129		1344
1130	=item $success = $term->selection_grab ($eventtime)	1345	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1131		1346
1132	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
1133	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
1134	is mostly useful from within C<on_sel_grab> hooks.	1350	is mostly useful from within C<on_sel_grab> hooks.
1135		1351
1136	=item $oldtext = $term->selection ([$newtext])	1352	=item $oldtext = $term->selection ([$newtext, $clipboard])
1137		1353
1138	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.
1139		1360
1140	=item $term->overlay_simple ($x, $y, $text)	1361	=item $term->overlay_simple ($x, $y, $text)
1141		1362
1142	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.
1143		1364
…		…
1173		1394
1174	The methods currently supported on C<urxvt::overlay> objects are:	1395	The methods currently supported on C<urxvt::overlay> objects are:
1175		1396
1176	=over 4	1397	=over 4
1177		1398
1178	=item $overlay->set ($x, $y, $text, $rend)	1399	=item $overlay->set ($x, $y, $text[, $rend])
1179		1400
1180	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
1181	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
1182	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.
1183		1406
1184	=item $overlay->hide	1407	=item $overlay->hide
1185		1408
1186	If visible, hide the overlay, but do not destroy it.	1409	If visible, hide the overlay, but do not destroy it.
1187		1410
…		…
1257		1480
1258	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
1259	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
1260	C<on_add_lines> hook, though.	1483	C<on_add_lines> hook, though.
1261		1484
		1485	=item $term->scr_change_screen ($screen)
		1486
		1487	Switch to given screen - 0 primary, 1 secondary.
		1488
1262	=item $term->cmd_parse ($octets)	1489	=item $term->cmd_parse ($octets)
1263		1490
1264	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
1265	locale-specific encoding of the terminal and can contain command sequences	1492	locale-specific encoding of the terminal and can contain command sequences
1266	(escape codes) that will be interpreted.	1493	(escape codes) that will be interpreted.
1267		1494
1268	=item $term->tt_write ($octets)	1495	=item $term->tt_write ($octets)
1269		1496
1270	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
1271	pass characters instead of octets, you should convert your strings first	1498	pass characters instead of octets, you should convert your strings first
1272	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.
1273		1514
1274	=item $old_events = $term->pty_ev_events ([$new_events])	1515	=item $old_events = $term->pty_ev_events ([$new_events])
1275		1516
1276	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
1277	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
1278	description of C<< urxvt::timer->events >>. Make sure to always restore	1519	description of C<< urxvt::timer->events >>. Make sure to always restore
1279	the previous value.	1520	the previous value.
1280		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
1281	=item $windowid = $term->parent	1527	=item $windowid = $term->parent
1282		1528
1283	Return the window id of the toplevel window.	1529	Return the window id of the toplevel window.
1284		1530
1285	=item $windowid = $term->vt	1531	=item $windowid = $term->vt
…		…
1291	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
1292	to receive pointer events all the times:	1538	to receive pointer events all the times:
1293		1539
1294	$term->vt_emask_add (urxvt::PointerMotionMask);	1540	$term->vt_emask_add (urxvt::PointerMotionMask);
1295		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
1296	=item $window_width = $term->width	1556	=item $window_width = $term->width
1297		1557
1298	=item $window_height = $term->height	1558	=item $window_height = $term->height
1299		1559
1300	=item $font_width = $term->fwidth	1560	=item $font_width = $term->fwidth
…		…
1330	=item $env = $term->env	1590	=item $env = $term->env
1331		1591
1332	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
1333	similar to C<\%ENV>.	1593	similar to C<\%ENV>.
1334		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
1335	=cut	1604	=cut
1336		1605
1337	sub env {	1606	sub env {
1338	if (my $env = $_[0]->_env) {
1339	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1607	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1340	} else {
1341	+{ %ENV }
1342	}
1343	}	1608	}
1344		1609
1345	=item $modifiermask = $term->ModLevel3Mask	1610	=item $modifiermask = $term->ModLevel3Mask
1346		1611
1347	=item $modifiermask = $term->ModMetaMask	1612	=item $modifiermask = $term->ModMetaMask
1348		1613
1349	=item $modifiermask = $term->ModNumLockMask	1614	=item $modifiermask = $term->ModNumLockMask
1350		1615
1351	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
1352	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.
1353		1626
1354	=item $view_start = $term->view_start ([$newvalue])	1627	=item $view_start = $term->view_start ([$newvalue])
1355		1628
1356	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
1357	C<0>, which displays the normal terminal contents. Lower values scroll	1630	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1365		1638
1366	Used after changing terminal contents to display them.	1639	Used after changing terminal contents to display them.
1367		1640
1368	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1641	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1369		1642
1370	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 >>
1371	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
1372	terminal line. The scrollback buffer starts at line C<-1> and extends to
1373	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1645	terminal line. Nothing will be returned if a nonexistent line
1374	is requested.	1646	is requested.
1375		1647
1376	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
1377	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
1378	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
1379	automatically be updated.	1651	automatically be updated.
1380		1652
1381	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
1382	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)
1383	(C<chr 65535>). Characters with combining characters and other characters	1655	characters. Characters with combining characters and other characters that
1384	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
1385	characters in the private use area.	1657	in the private use area.
1386		1658
1387	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
1388	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
1389	characters.	1661	characters.
1390		1662
…		…
1474	}	1746	}
1475		1747
1476	sub urxvt::line::t {	1748	sub urxvt::line::t {
1477	my ($self) = @_;	1749	my ($self) = @_;
1478		1750
1479	if (@_ > 1)	1751	if (@_ > 1) {
1480	{
1481	$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})
1482	for $self->{beg} .. $self->{end};	1753	for $self->{beg} .. $self->{end};
1483	}	1754	}
1484		1755
1485	defined wantarray &&	1756	defined wantarray &&
1486	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1757	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1487	0, $self->{len}	1758	0, $self->{len}
1488	}	1759	}
1489		1760
1490	sub urxvt::line::r {	1761	sub urxvt::line::r {
1491	my ($self) = @_;	1762	my ($self) = @_;
1492		1763
1493	if (@_ > 1)	1764	if (@_ > 1) {
1494	{
1495	$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})
1496	for $self->{beg} .. $self->{end};	1766	for $self->{beg} .. $self->{end};
1497	}	1767	}
1498		1768
1499	if (defined wantarray) {	1769	if (defined wantarray) {
1500	my $rend = [	1770	my $rend = [
1501	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1771	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1502	];	1772	];
…		…
1534	where one character corresponds to one screen cell. See	1804	where one character corresponds to one screen cell. See
1535	C<< $term->ROW_t >> for details.	1805	C<< $term->ROW_t >> for details.
1536		1806
1537	=item $string = $term->special_decode $text	1807	=item $string = $term->special_decode $text
1538		1808
1539	Converts rxvt-unicodes text reprsentation into a perl string. See	1809	Converts rxvt-unicodes text representation into a perl string. See
1540	C<< $term->ROW_t >> for details.	1810	C<< $term->ROW_t >> for details.
1541		1811
1542	=item $success = $term->grab_button ($button, $modifiermask)	1812	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1543		1813
		1814	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1815
1544	Registers a synchronous button grab. See the XGrabButton manpage.	1816	Register/unregister a synchronous button grab. See the XGrabButton
		1817	manpage.
1545		1818
1546	=item $success = $term->grab ($eventtime[, $sync])	1819	=item $success = $term->grab ($eventtime[, $sync])
1547		1820
1548	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1821	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1549	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1822	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1550		1823
1551	=item $term->allow_events_async	1824	=item $term->allow_events_async
1552		1825
1553	Calls XAllowEvents with AsyncBoth for the most recent grab.	1826	Calls XAllowEvents with AsyncBoth for the most recent grab.
1554		1827
…		…
1561	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1834	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1562	recent grab.	1835	recent grab.
1563		1836
1564	=item $term->ungrab	1837	=item $term->ungrab
1565		1838
1566	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
1567	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
1568	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.
1569		1876
1570	=back	1877	=back
1571		1878
1572	=cut	1879	=cut
1573		1880
…		…
1637	my ($self, $text, $cb) = @_;	1944	my ($self, $text, $cb) = @_;
1638		1945
1639	$self->add_item ({ type => "button", text => $text, activate => $cb});	1946	$self->add_item ({ type => "button", text => $text, activate => $cb});
1640	}	1947	}
1641		1948
1642	=item $popup->add_toggle ($text, $cb, $initial_value)	1949	=item $popup->add_toggle ($text, $initial_value, $cb)
1643		1950
1644	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
1645	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
1646	argument.	1953	first argument.
1647		1954
1648	=cut	1955	=cut
1649		1956
1650	sub add_toggle {	1957	sub add_toggle {
1651	my ($self, $text, $cb, $value) = @_;	1958	my ($self, $text, $value, $cb) = @_;
1652		1959
1653	my $item; $item = {	1960	my $item; $item = {
1654	type => "button",	1961	type => "button",
1655	text => " $text",	1962	text => " $text",
1656	value => $value,	1963	value => $value,
…		…
1675	my $env = $self->{term}->env;	1982	my $env = $self->{term}->env;
1676	# 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.
1677	delete $env->{LC_ALL};	1984	delete $env->{LC_ALL};
1678	$env->{LC_CTYPE} = $self->{term}->locale;	1985	$env->{LC_CTYPE} = $self->{term}->locale;
1679		1986
1680	urxvt::term->new ($env, "popup",	1987	my $term = urxvt::term->new (
		1988	$env, "popup",
1681	"--perl-lib" => "", "--perl-ext-common" => "",	1989	"--perl-lib" => "", "--perl-ext-common" => "",
1682	"-pty-fd" => -1, "-sl" => 0,	1990	"-pty-fd" => -1, "-sl" => 0,
1683	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1991	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1684	"--transient-for" => $self->{term}->parent,	1992	"--transient-for" => $self->{term}->parent,
1685	"-display" => $self->{term}->display_id,	1993	"-display" => $self->{term}->display_id,
1686	"-pe" => "urxvt-popup")	1994	"-pe" => "urxvt-popup",
1687	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	}
1688	}	2002	}
1689		2003
1690	sub DESTROY {	2004	sub DESTROY {
1691	my ($self) = @_;	2005	my ($self) = @_;
1692		2006
…		…
1697	=back	2011	=back
1698		2012
1699	=cut	2013	=cut
1700		2014
1701	package urxvt::watcher;	2015	package urxvt::watcher;
1702
1703	@urxvt::timer::ISA = __PACKAGE__;
1704	@urxvt::iow::ISA = __PACKAGE__;
1705	@urxvt::pw::ISA = __PACKAGE__;
1706	@urxvt::iw::ISA = __PACKAGE__;
1707		2016
1708	=head2 The C<urxvt::timer> Class	2017	=head2 The C<urxvt::timer> Class
1709		2018
1710	This class implements timer watchers/events. Time is represented as a	2019	This class implements timer watchers/events. Time is represented as a
1711	fractional number of seconds since the epoch. Example:	2020	fractional number of seconds since the epoch. Example:
…		…
1715	->new	2024	->new
1716	->interval (1)	2025	->interval (1)
1717	->cb (sub {	2026	->cb (sub {
1718	$term->{overlay}->set (0, 0,	2027	$term->{overlay}->set (0, 0,
1719	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2028	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1720	});	2029	});
1721		2030
1722	=over 4	2031	=over 4
1723		2032
1724	=item $timer = new urxvt::timer	2033	=item $timer = new urxvt::timer
1725		2034
…		…
1728		2037
1729	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2038	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1730		2039
1731	Set the callback to be called when the timer triggers.	2040	Set the callback to be called when the timer triggers.
1732		2041
1733	=item $tstamp = $timer->at
1734
1735	Return the time this watcher will fire next.
1736
1737	=item $timer = $timer->set ($tstamp)	2042	=item $timer = $timer->set ($tstamp[, $interval])
1738		2043
1739	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).
1740		2046
1741	=item $timer = $timer->interval ($interval)	2047	=item $timer = $timer->interval ($interval)
1742		2048
1743	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
1744	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
1745	is automatically rescheduled at the given intervals.	2051	is automatically rescheduled at the given intervals.
1746		2052
1747	=item $timer = $timer->start	2053	=item $timer = $timer->start
1748		2054
1749	Start the timer.	2055	Start the timer.
1750		2056
1751	=item $timer = $timer->start ($tstamp)	2057	=item $timer = $timer->start ($tstamp[, $interval])
1752		2058
1753	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.
1754		2061
1755	=item $timer = $timer->after ($delay)	2062	=item $timer = $timer->after ($delay[, $interval])
1756		2063
1757	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>.
1758		2065
1759	=item $timer = $timer->stop	2066	=item $timer = $timer->stop
1760		2067
…		…
1768		2075
1769	$term->{socket} = ...	2076	$term->{socket} = ...
1770	$term->{iow} = urxvt::iow	2077	$term->{iow} = urxvt::iow
1771	->new	2078	->new
1772	->fd (fileno $term->{socket})	2079	->fd (fileno $term->{socket})
1773	->events (urxvt::EVENT_READ)	2080	->events (urxvt::EV_READ)
1774	->start	2081	->start
1775	->cb (sub {	2082	->cb (sub {
1776	my ($iow, $revents) = @_;	2083	my ($iow, $revents) = @_;
1777	# $revents must be 1 here, no need to check	2084	# $revents must be 1 here, no need to check
1778	sysread $term->{socket}, my $buf, 8192	2085	sysread $term->{socket}, my $buf, 8192
…		…
1791	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>
1792	is a bitset as described in the C<events> method.	2099	is a bitset as described in the C<events> method.
1793		2100
1794	=item $iow = $iow->fd ($fd)	2101	=item $iow = $iow->fd ($fd)
1795		2102
1796	Set the filedescriptor (not handle) to watch.	2103	Set the file descriptor (not handle) to watch.
1797		2104
1798	=item $iow = $iow->events ($eventmask)	2105	=item $iow = $iow->events ($eventmask)
1799		2106
1800	Set the event mask to watch. The only allowed values are	2107	Set the event mask to watch. The only allowed values are
1801	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
1802	together, or C<urxvt::EVENT_NONE>.	2109	together, or C<urxvt::EV_NONE>.
1803		2110
1804	=item $iow = $iow->start	2111	=item $iow = $iow->start
1805		2112
1806	Start watching for requested events on the given handle.	2113	Start watching for requested events on the given handle.
1807		2114
1808	=item $iow = $iow->stop	2115	=item $iow = $iow->stop
1809		2116
1810	Stop watching for events on the given filehandle.	2117	Stop watching for events on the given file handle.
1811		2118
1812	=back	2119	=back
1813		2120
1814	=head2 The C<urxvt::iw> Class	2121	=head2 The C<urxvt::iw> Class
1815		2122
…		…
1848	->new	2155	->new
1849	->start ($pid)	2156	->start ($pid)
1850	->cb (sub {	2157	->cb (sub {
1851	my ($pw, $exit_status) = @_;	2158	my ($pw, $exit_status) = @_;
1852	...	2159	...
1853	});	2160	});
1854		2161
1855	=over 4	2162	=over 4
1856		2163
1857	=item $pw = new urxvt::pw	2164	=item $pw = new urxvt::pw
1858		2165
…		…
1862		2169
1863	Set the callback to be called when the timer triggers.	2170	Set the callback to be called when the timer triggers.
1864		2171
1865	=item $pw = $timer->start ($pid)	2172	=item $pw = $timer->start ($pid)
1866		2173
1867	Tells the wqtcher to start watching for process C<$pid>.	2174	Tells the watcher to start watching for process C<$pid>.
1868		2175
1869	=item $pw = $pw->stop	2176	=item $pw = $pw->stop
1870		2177
1871	Stop the watcher.	2178	Stop the watcher.
1872		2179
…		…
1885		2192
1886	=item >= 3 - script loading and management	2193	=item >= 3 - script loading and management
1887		2194
1888	=item >=10 - all called hooks	2195	=item >=10 - all called hooks
1889		2196
1890	=item >=11 - hook reutrn values	2197	=item >=11 - hook return values
1891		2198
1892	=back	2199	=back
1893		2200
1894	=head1 AUTHOR	2201	=head1 AUTHOR
1895		2202
1896	Marc Lehmann <pcg@goof.com>	2203	Marc Lehmann <schmorp@schmorp.de>
1897	http://software.schmorp.de/pkg/rxvt-unicode	2204	http://software.schmorp.de/pkg/rxvt-unicode
1898		2205
1899	=cut	2206	=cut
1900		2207
1901	1	2208	1
		2209
		2210	# vim: sw=3:

Diff Legend

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