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.124 by root, Sun Jan 22 11:57:06 2006 UTC vs.
Revision 1.228 by sf-exg, Tue Oct 29 14:12:58 2013 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 readline (enabled by default)
133
134	A support package that tries to make editing with readline easier. At the
135	moment, it reacts to clicking with the left mouse button by trying to
136	move the text cursor to this position. It does so by generating as many
137	cursor-left or cursor-right keypresses as required (the this only works
138	for programs that correctly support wide characters).
139
140	To avoid too many false positives, this is only done when:
141
142	=over 4
143
144	=item - the mouse is on the same (multi-row-) line as the text cursor.
145
146	=item - the primary screen is currently being displayed.
147
148	=item - the text cursor is visible.
149
150	=back
151
152	The normal selection mechanism isn't disabled, so quick successive clicks
153	might interfere with selection creation in harmless ways.
154
155	=item selection-autotransform
156
157	This selection allows you to do automatic transforms on a selection
158	whenever a selection is made.
159
160	It works by specifying perl snippets (most useful is a single C<s///>
161	operator) that modify C<$_> as resources:
162
163	URxvt.selection-autotransform.0: transform
164	URxvt.selection-autotransform.1: transform
165	...
166
167	For example, the following will transform selections of the form
168	C<filename:number>, often seen in compiler messages, into C<vi +$filename
169	$word>:
170
171	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
172
173	And this example matches the same,but replaces it with vi-commands you can
174	paste directly into your (vi :) editor:
175
176	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
177
178	Of course, this can be modified to suit your needs and your editor :)
179
180	To expand the example above to typical perl error messages ("XXX at
181	FILENAME line YYY."), you need a slightly more elaborate solution:
182
183	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
184	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
185
186	The first line tells the selection code to treat the unchanging part of
187	every error message as a selection pattern, and the second line transforms
188	the message into vi commands to load the file.
189
190	=item tabbed
191
192	This transforms the terminal into a tabbar with additional terminals, that
193	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
194	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
195	button per tab.
196
197	Clicking a button will activate that tab. Pressing B<Shift-Left> and
198	B<Shift-Right> will switch to the tab left or right of the current one,
199	while B<Shift-Down> creates a new tab.
200
201	=item mark-urls
202
203	Uses per-line display filtering (C<on_line_update>) to underline urls and
204	make them clickable. When middle-clicked, the program specified in the
205	resource C<urlLauncher> (default C<x-www-browser>) will be started with
206	the URL as first argument.
207
208	=item automove-background
209
210	This is basically a one-line extension that dynamically changes the background pixmap offset
211	to the window position, in effect creating the same effect as pseudo transparency with
212	a custom pixmap. No scaling is supported in this mode. Exmaple:
213
214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
215
216	=item block-graphics-to-ascii
217
218	A not very useful example of filtering all text output to the terminal,
219	by replacing all line-drawing characters (U+2500 .. U+259F) by a
220	similar-looking ascii character.
221
222	=item digital-clock
223
224	Displays a digital clock using the built-in overlay.
225
226	=item example-refresh-hooks
227
228	Displays a very simple digital clock in the upper right corner of the
229	window. Illustrates overwriting the refresh callbacks to create your own
230	overlays or changes.
231
232	=item selection-pastebin
233
234	This is a little rarely useful extension that Uploads the selection as
235	textfile to a remote site (or does other things). (The implementation is
236	not currently secure for use in a multiuser environment as it writes to
237	F</tmp> directly.).
238
239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
240	i.e.
241
242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
243
244	Pressing this combination runs a command with C<%> replaced by the name of
245	the textfile. This command can be set via a resource:
246
247	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
248
249	And the default is likely not useful to anybody but the few people around
250	here :)
251
252	The name of the textfile is the hex encoded md5 sum of the selection, so
253	the same content should lead to the same filename.
254
255	After a successful upload the selection will be replaced by the text given
256	in the C<selection-pastebin-url> resource (again, the % is the placeholder
257	for the filename):
258
259	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
260
261	=back
262		50
263	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
264		52
265	=head2 General API Considerations	53	=head2 General API Considerations
266		54
…		…
280		68
281	=over 4	69	=over 4
282		70
283	=item $text	71	=item $text
284		72
285	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
286	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.
287		75
288	=item $string	76	=item $string
289		77
290	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
…		…
294	=item $octets	82	=item $octets
295		83
296	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
297	locale-specific way.	85	locale-specific way.
298		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
299	=back	93	=back
300		94
301	=head2 Extension Objects	95	=head2 Extension Objects
302		96
303	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
304	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,
305	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
306	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
307	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
308	use.	103	internal use.
309		104
310	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
311	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
312		107
313	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
314		109	the C<urxvt::extension> section below.
315	=over 4
316
317	=item $urxvt_term = $self->{term}
318
319	Returns the C<urxvt::term> object associated with this instance of the
320	extension. This member I<must not> be changed in any way.
321
322	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
323
324	Dynamically enable the given hooks (named without the C<on_> prefix) for
325	this extension, replacing any previous hook. This is useful when you want
326	to overwrite time-critical hooks only temporarily.
327
328	=item $self->disable ($hook_name[, $hook_name..])
329
330	Dynamically disable the given hooks.
331
332	=back
333		110
334	=head2 Hooks	111	=head2 Hooks
335		112
336	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
337	called whenever the relevant event happens.	114	called whenever the relevant event happens.
338		115
339	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
340	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
341		118
342	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
343	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
344	relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
…		…
357	place.	134	place.
358		135
359	=item on_start $term	136	=item on_start $term
360		137
361	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
362	trying to map (display) the toplevel and returning to the mainloop.	139	trying to map (display) the toplevel and returning to the main loop.
363		140
364	=item on_destroy $term	141	=item on_destroy $term
365		142
366	Called whenever something tries to destroy terminal, before doing anything	143	Called whenever something tries to destroy terminal, when the terminal is
367	yet. If this hook returns true, then destruction is skipped, but this is	144	still fully functional (not for long, though).
368	rarely a good idea.
369		145
370	=item on_reset $term	146	=item on_reset $term
371		147
372	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
373	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
…		…
395		171
396	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
397	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
398	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
399		175
400	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.
401		177
402	=item on_sel_extend $term	178	=item on_sel_extend $term
403		179
404	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
405	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
406	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
407	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
408	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
409	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
410		186
411	See the F<selection> example extension.	187	See the F<selection> example extension.
412		188
413	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
414		190
415	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
416	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
417	show this many lines of scrollback.	193	show this many lines of scrollback.
418		194
419	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
420		196
…		…
424		200
425	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,
426	$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
427	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
428		204
429	=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
430		216
431	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
432	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
433	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
434	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,
435	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
436	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	}
437		233
438	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,
439	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
440	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.
441		240
442	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
443		242
444	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
445	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
…		…
450	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
451		250
452	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
453	suppress or filter tty input.	252	suppress or filter tty input.
454		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
455	=item on_line_update $term, $row	261	=item on_line_update $term, $row
456		262
457	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
458	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
459	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,
…		…
466	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
467	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
468		274
469	=item on_refresh_begin $term	275	=item on_refresh_begin $term
470		276
471	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
472	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
473	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
474	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
475		281
476	=item on_refresh_end $term	282	=item on_refresh_end $term
477		283
478	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>.
479		285
480	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string
481		287
482	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
483	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>
484	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 assumed to change
		293	slightly in the future.
		294
		295	=item on_register_command $term, $keysym, $modifiermask, $string
		296
		297	Called after parsing a keysym resource but before registering the
		298	associated binding. If this hook returns TRUE the binding is not
		299	registered. It can be used to modify a binding by calling
		300	C<register_command>.
		301
		302	=item on_resize_all_windows $term, $new_width, $new_height
		303
		304	Called just after the new window size has been calculated, but before
		305	windows are actually being resized or hints are being set. If this hook
		306	returns TRUE, setting of the window hints is being skipped.
485		307
486	=item on_x_event $term, $event	308	=item on_x_event $term, $event
487		309
488	Called on every X event received on the vt window (and possibly other	310	Called on every X event received on the vt window (and possibly other
489	windows). Should only be used as a last resort. Most event structure	311	windows). Should only be used as a last resort. Most event structure
490	members are not passed.	312	members are not passed.
491		313
		314	=item on_root_event $term, $event
		315
		316	Like C<on_x_event>, but is called for events on the root window.
		317
492	=item on_focus_in $term	318	=item on_focus_in $term
493		319
494	Called whenever the window gets the keyboard focus, before rxvt-unicode	320	Called whenever the window gets the keyboard focus, before rxvt-unicode
495	does focus in processing.	321	does focus in processing.
496		322
497	=item on_focus_out $term	323	=item on_focus_out $term
498		324
499	Called wheneever the window loses keyboard focus, before rxvt-unicode does	325	Called whenever the window loses keyboard focus, before rxvt-unicode does
500	focus out processing.	326	focus out processing.
501		327
502	=item on_configure_notify $term, $event	328	=item on_configure_notify $term, $event
503		329
504	=item on_property_notify $term, $event	330	=item on_property_notify $term, $event
…		…
515		341
516	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
517		343
518	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
519		345
520	Called whenever the corresponding X event is received for the terminal If	346	Called whenever the corresponding X event is received for the terminal. If
521	the hook returns true, then the even will be ignored by rxvt-unicode.	347	the hook returns true, then the event will be ignored by rxvt-unicode.
522		348
523	The event is a hash with most values as named by Xlib (see the XEvent	349	The event is a hash with most values as named by Xlib (see the XEvent
524	manpage), with the additional members C<row> and C<col>, which are the	350	manpage), with the additional members C<row> and C<col>, which are the
525	(real, not screen-based) row and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
526		352
…		…
536	=item on_wm_delete_window $term, $event	362	=item on_wm_delete_window $term, $event
537		363
538	Called when various types of ClientMessage events are received (all with	364	Called when various types of ClientMessage events are received (all with
539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
540		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
541	=back	371	=back
542		372
543	=cut	373	=cut
544		374
545	package urxvt;	375	package urxvt;
546		376
547	use utf8;	377	use utf8;
548	use strict;	378	use strict 'vars';
549	use Carp ();	379	use Carp ();
550	use Scalar::Util ();	380	use Scalar::Util ();
551	use List::Util ();	381	use List::Util ();
552		382
553	our $VERSION = 1;	383	our $VERSION = 1;
554	our $TERM;	384	our $TERM;
555	our @TERM_INIT;	385	our @TERM_INIT; # should go, prevents async I/O etc.
556	our @TERM_EXT;	386	our @TERM_EXT; # should go, prevents async I/O etc.
557	our @HOOKNAME;	387	our @HOOKNAME;
558	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
559	our %OPTION;	389	our %OPTION;
560		390
561	our $LIBDIR;	391	our $LIBDIR;
…		…
587	The current terminal. This variable stores the current C<urxvt::term>	417	The current terminal. This variable stores the current C<urxvt::term>
588	object, whenever a callback/hook is executing.	418	object, whenever a callback/hook is executing.
589		419
590	=item @urxvt::TERM_INIT	420	=item @urxvt::TERM_INIT
591		421
592	All coderefs in this array will be called as methods of the next newly	422	All code references in this array will be called as methods of the next newly
593	created C<urxvt::term> object (during the C<on_init> phase). The array	423	created C<urxvt::term> object (during the C<on_init> phase). The array
594	gets cleared before the codereferences that were in it are being executed,	424	gets cleared before the code references that were in it are being executed,
595	so coderefs can push themselves onto it again if they so desire.	425	so references can push themselves onto it again if they so desire.
596		426
597	This complements to the perl-eval commandline option, but gets executed	427	This complements to the perl-eval command line option, but gets executed
598	first.	428	first.
599		429
600	=item @urxvt::TERM_EXT	430	=item @urxvt::TERM_EXT
601		431
602	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	432	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
609		439
610	=over 4	440	=over 4
611		441
612	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
613		443
614	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
615	costs! The only time this is acceptable is when the terminal process	445	include a trailing newline). Avoid at all costs! The only time this
616	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
617		448
618	=item urxvt::warn $string	449	=item urxvt::warn $string
619		450
620	Calls C<rxvt_warn> with the given string which should not include a	451	Calls C<rxvt_warn> with the given string which should include a trailing
621	newline. The module also overwrites the C<warn> builtin with a function	452	newline. The module also overwrites the C<warn> builtin with a function
622	that calls this function.	453	that calls this function.
623		454
624	Using this function has the advantage that its output ends up in the	455	Using this function has the advantage that its output ends up in the
625	correct place, e.g. on stderr of the connecting urxvtc client.	456	correct place, e.g. on stderr of the connecting urxvtc client.
626		457
627	Messages have a size limit of 1023 bytes currently.	458	Messages have a size limit of 1023 bytes currently.
		459
		460	=item @terms = urxvt::termlist
		461
		462	Returns all urxvt::term objects that exist in this process, regardless of
		463	whether they are started, being destroyed etc., so be careful. Only term
		464	objects that have perl extensions attached will be returned (because there
		465	is no urxvt::term object associated with others).
628		466
629	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
630		468
631	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
632		470
…		…
675		513
676	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
677		515
678	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
679		517
680	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	518	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		519	urxvt::RS_RVid, urxvt::RS_Uline
681		520
682	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
683	underline, respectively. To enable such a style, just logically OR it into	522	underline, respectively. To enable such a style, just logically OR it into
684	the bitset.	523	the bitset.
685		524
…		…
690	Return the foreground/background colour index, respectively.	529	Return the foreground/background colour index, respectively.
691		530
692	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	531	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
693		532
694	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	533	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		534
		535	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
695		536
696	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
697	specified one.	538	specified one.
698		539
699	=item $value = urxvt::GET_CUSTOM $rend	540	=item $value = urxvt::GET_CUSTOM $rend
…		…
720	};	561	};
721	}	562	}
722		563
723	no warnings 'utf8';	564	no warnings 'utf8';
724		565
		566	sub parse_resource {
		567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		568
		569	$name =~ y/-/./ if $isarg;
		570
		571	$term->scan_meta;
		572
		573	my $r = $term->{meta}{resource};
		574	keys %$r; # reset iterator
		575	while (my ($pattern, $v) = each %$r) {
		576	if (
		577	$pattern =~ /\.$/
		578	? $pattern eq substr $name, 0, length $pattern
		579	: $pattern eq $name
		580	) {
		581	$name = "$urxvt::RESCLASS.$name";
		582
		583	push @{ $term->{perl_ext_3} }, $v->[0];
		584
		585	if ($v->[1] eq "boolean") {
		586	$term->put_option_db ($name, $flag ? "true" : "false");
		587	return 1;
		588	} else {
		589	$term->put_option_db ($name, $value);
		590	return 1 + 2;
		591	}
		592	}
		593	}
		594
		595	0
		596	}
		597
		598	sub usage {
		599	my ($term, $usage_type) = @_;
		600
		601	$term->scan_meta;
		602
		603	my $r = $term->{meta}{resource};
		604
		605	for my $pattern (sort keys %$r) {
		606	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		607
		608	$desc .= " (-pe $ext)";
		609
		610	if ($usage_type == 1) {
		611	$pattern =~ y/./-/;
		612	$pattern =~ s/-$/-.../g;
		613
		614	if ($type eq "boolean") {
		615	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		616	} else {
		617	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		618	}
		619	} else {
		620	$pattern =~ s/\.$/.*/g;
		621	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		622	}
		623	}
		624	}
		625
725	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
726		627
727	sub verbose {	628	sub verbose {
728	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
729	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
…		…
741	$pkg =~ s/[^[:word:]]/_/g;	642	$pkg =~ s/[^[:word:]]/_/g;
742	$pkg = "urxvt::ext::$pkg";	643	$pkg = "urxvt::ext::$pkg";
743		644
744	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
745		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		648
746	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
747	or die "$path: $!";	650	or die "$path: $!";
748		651
749	my $source =	652	my $source =
750	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
751	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
752	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
753	. "\n};\n1";	656	. "\n};\n1";
754		657
755	eval $source	658	eval $source
…		…
765	sub invoke {	668	sub invoke {
766	local $TERM = shift;	669	local $TERM = shift;
767	my $htype = shift;	670	my $htype = shift;
768		671
769	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
770	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
771		674
772	my %ext_arg;	675	my %ext_arg;
773		676
774	{	677	{
775	my @init = @TERM_INIT;	678	my @init = @TERM_INIT;
776	@TERM_INIT = ();	679	@TERM_INIT = ();
…		…
778	my @pkg = @TERM_EXT;	681	my @pkg = @TERM_EXT;
779	@TERM_EXT = ();	682	@TERM_EXT = ();
780	$TERM->register_package ($_) for @pkg;	683	$TERM->register_package ($_) for @pkg;
781	}	684	}
782		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
783	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
784	if ($_ eq "default") {	690	if ($_ eq "default") {
785	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	691	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
786	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
787	delete $ext_arg{$1};	693	delete $ext_arg{$1};
788	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
…		…
790	} else {	696	} else {
791	$ext_arg{$_} ||= [];	697	$ext_arg{$_} ||= [];
792	}	698	}
793	}	699	}
794		700
795	while (my ($ext, $argv) = each %ext_arg) {	701	for my $ext (sort keys %ext_arg) {
796	my @files = grep -f $_, map "$_/$ext", @dirs;	702	my @files = grep -f $_, map "$_/$ext", @dirs;
797		703
798	if (@files) {	704	if (@files) {
799	$TERM->register_package (extension_package $files[0], $argv);	705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
800	} else {	706	} else {
801	warn "perl extension '$ext' not found in perl library search path\n";	707	warn "perl extension '$ext' not found in perl library search path\n";
802	}	708	}
803	}	709	}
804		710
…		…
810		716
811	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
812	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
813	if $verbosity >= 10;	719	if $verbosity >= 10;
814		720
815	keys %$cb;	721	for my $pkg (keys %$cb) {
816
817	while (my ($pkg, $cb) = each %$cb) {
818	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
819	$retval ||= $retval_;	723	$retval ||= $retval_;
820		724
821	if ($@) {	725	if ($@) {
822	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
823	warn $@;	727	warn $@;
…		…
837	}	741	}
838		742
839	$retval	743	$retval
840	}	744	}
841		745
842	# urxvt::term::extension	746	sub SET_COLOR($$$) {
		747	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		748	}
		749
		750	sub rend2mask {
		751	no strict 'refs';
		752	my ($str, $mask) = (@_, 0);
		753	my %color = ( fg => undef, bg => undef );
		754	my @failed;
		755	for my $spec ( split /\s+/, $str ) {
		756	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		757	$color{lc($1)} = $2;
		758	} else {
		759	my $neg = $spec =~ s/^[-^]//;
		760	unless ( exists &{"RS_$spec"} ) {
		761	push @failed, $spec;
		762	next;
		763	}
		764	my $cur = &{"RS_$spec"};
		765	if ( $neg ) {
		766	$mask &= ~$cur;
		767	} else {
		768	$mask |= $cur;
		769	}
		770	}
		771	}
		772	($mask, @color{qw(fg bg)}, \@failed)
		773	}
843		774
844	package urxvt::term::extension;	775	package urxvt::term::extension;
845		776
846	sub enable {	777	=head2 The C<urxvt::term::extension> class
847	my ($self, %hook) = @_;
848	my $pkg = $self->{_pkg};
849		778
850	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
851	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
852	defined $htype
853	or Carp::croak "unsupported hook type '$name'";
854		781
855	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
856	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
857		784
858	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
859	}	786	objects, in addition to call methods documented for the <urxvt::term>
860	}	787	class.
861		788
862	sub disable {	789	=over 4
863	my ($self, @hook) = @_;
864	my $pkg = $self->{_pkg};
865		790
866	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
867	my $htype = $HOOKTYPE{uc $name};
868	defined $htype
869	or Carp::croak "unsupported hook type '$name'";
870		792
871	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
872	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
873	}	795
874	}	796	=cut
875		797
876	our $AUTOLOAD;	798	our $AUTOLOAD;
877		799
878	sub AUTOLOAD {	800	sub AUTOLOAD {
879	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
892		814
893	sub DESTROY {	815	sub DESTROY {
894	# nop	816	# nop
895	}	817	}
896		818
897	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
898		820
899	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
900	${$_[0]}->();	822	${$_[0]}->();
901	}	823	}
902		824
903	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
904	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
905	}	827	}
		828
		829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		830
		831	Dynamically enable the given hooks (named without the C<on_> prefix) for
		832	this extension, replacing any previous hook. This is useful when you want
		833	to overwrite time-critical hooks only temporarily.
		834
		835	To install additional callbacks for the same hook, you can use the C<on>
		836	method of the C<urxvt::term> class.
		837
		838	=item $self->disable ($hook_name[, $hook_name..])
		839
		840	Dynamically disable the given hooks.
		841
		842	=cut
		843
		844	sub enable {
		845	my ($self, %hook) = @_;
		846	my $pkg = $self->{_pkg};
		847
		848	while (my ($name, $cb) = each %hook) {
		849	my $htype = $HOOKTYPE{uc $name};
		850	defined $htype
		851	or Carp::croak "unsupported hook type '$name'";
		852
		853	$self->set_should_invoke ($htype, +1)
		854	unless exists $self->{term}{_hook}[$htype]{$pkg};
		855
		856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		857	}
		858	}
		859
		860	sub disable {
		861	my ($self, @hook) = @_;
		862	my $pkg = $self->{_pkg};
		863
		864	for my $name (@hook) {
		865	my $htype = $HOOKTYPE{uc $name};
		866	defined $htype
		867	or Carp::croak "unsupported hook type '$name'";
		868
		869	$self->set_should_invoke ($htype, -1)
		870	if delete $self->{term}{_hook}[$htype]{$pkg};
		871	}
		872	}
		873
		874	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		875
		876	Similar to the C<enable> enable, but installs additional callbacks for
		877	the given hook(s) (that is, it doesn't replace existing callbacks), and
		878	returns a guard object. When the guard object is destroyed the callbacks
		879	are disabled again.
		880
		881	=cut
		882
		883	sub urxvt::extension::on_disable::DESTROY {
		884	my $disable = shift;
		885
		886	my $term = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	delete $term->{_hook}[$htype]{$id};
		890	$term->set_should_invoke ($htype, -1);
		891	}
		892	}
		893
		894	sub on {
		895	my ($self, %hook) = @_;
		896
		897	my $term = $self->{term};
		898
		899	my %disable = ( "" => $term );
		900
		901	while (my ($name, $cb) = each %hook) {
		902	my $htype = $HOOKTYPE{uc $name};
		903	defined $htype
		904	or Carp::croak "unsupported hook type '$name'";
		905
		906	$term->set_should_invoke ($htype, +1);
		907	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		908	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		909	}
		910
		911	bless \%disable, "urxvt::extension::on_disable"
		912	}
		913
		914	=item $self->x_resource ($pattern)
		915
		916	=item $self->x_resource_boolean ($pattern)
		917
		918	These methods support an additional C<%> prefix when called on an
		919	extension object - see the description of these methods in the
		920	C<urxvt::term> class for details.
		921
		922	=cut
		923
		924	sub x_resource {
		925	my ($self, $name) = @_;
		926	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		927	$self->{term}->x_resource ($name)
		928	}
		929
		930	sub x_resource_boolean {
		931	my ($self, $name) = @_;
		932	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		933	$self->{term}->x_resource_boolean ($name)
		934	}
		935
		936	=back
		937
		938	=cut
906		939
907	package urxvt::anyevent;	940	package urxvt::anyevent;
908		941
909	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
910		943
911	The sole purpose of this class is to deliver an interface to the	944	The sole purpose of this class is to deliver an interface to the
912	C<AnyEvent> module - any module using it will work inside urxvt without	945	C<AnyEvent> module - any module using it will work inside urxvt without
913	further programming. The only exception is that you cannot wait on	946	further programming. The only exception is that you cannot wait on
914	condition variables, but non-blocking condvar use is ok. What this means	947	condition variables, but non-blocking condvar use is ok.
915	is that you cannot use blocking APIs, but the non-blocking variant should
916	work.
917		948
918	=cut	949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
919		951
		952	=cut
		953
920	our $VERSION = 1;	954	our $VERSION = '5.23';
921		955
922	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	956	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
923	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	957	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
924		958
925	sub timer {	959	sub timer {
…		…
927		961
928	my $cb = $arg{cb};	962	my $cb = $arg{cb};
929		963
930	urxvt::timer	964	urxvt::timer
931	->new	965	->new
932	->start (urxvt::NOW + $arg{after})	966	->after ($arg{after}, $arg{interval})
933	->cb (sub {	967	->cb ($arg{interval} ? $cb : sub {
934	$_[0]->stop; # need to cancel manually	968	$_[0]->stop; # need to cancel manually
935	$cb->();	969	$cb->();
936	})	970	})
937	}	971	}
938		972
939	sub io {	973	sub io {
940	my ($class, %arg) = @_;	974	my ($class, %arg) = @_;
941		975
942	my $cb = $arg{cb};	976	my $cb = $arg{cb};
		977	my $fd = fileno $arg{fh};
		978	defined $fd or $fd = $arg{fh};
943		979
944	bless [$arg{fh}, urxvt::iow	980	bless [$arg{fh}, urxvt::iow
945	->new	981	->new
946	->fd (fileno $arg{fh})	982	->fd ($fd)
947	->events (($arg{poll} =~ /r/ ? 1 : 0)	983	->events (($arg{poll} =~ /r/ ? 1 : 0)
948	| ($arg{poll} =~ /w/ ? 2 : 0))	984	| ($arg{poll} =~ /w/ ? 2 : 0))
949	->start	985	->start
950	->cb (sub {	986	->cb ($cb)
951	$cb->(($_[1] & 1 ? 'r' : '')
952	. ($_[1] & 2 ? 'w' : ''));
953	})],
954	urxvt::anyevent::	987	], urxvt::anyevent::
		988	}
		989
		990	sub idle {
		991	my ($class, %arg) = @_;
		992
		993	my $cb = $arg{cb};
		994
		995	urxvt::iw
		996	->new
		997	->start
		998	->cb ($cb)
		999	}
		1000
		1001	sub child {
		1002	my ($class, %arg) = @_;
		1003
		1004	my $cb = $arg{cb};
		1005
		1006	urxvt::pw
		1007	->new
		1008	->start ($arg{pid})
		1009	->cb (sub {
		1010	$_[0]->stop; # need to cancel manually
		1011	$cb->($_[0]->rpid, $_[0]->rstatus);
		1012	})
955	}	1013	}
956		1014
957	sub DESTROY {	1015	sub DESTROY {
958	$_[0][1]->stop;	1016	$_[0][1]->stop;
959	}	1017	}
960		1018
961	sub condvar {	1019	# only needed for AnyEvent < 6 compatibility
962	bless \my $flag, urxvt::anyevent::condvar::	1020	sub one_event {
963	}
964
965	sub urxvt::anyevent::condvar::broadcast {
966	${$_[0]}++;
967	}
968
969	sub urxvt::anyevent::condvar::wait {
970	unless (${$_[0]}) {
971	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1021	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
972	}
973	}	1022	}
974		1023
975	package urxvt::term;	1024	package urxvt::term;
976		1025
977	=head2 The C<urxvt::term> Class	1026	=head2 The C<urxvt::term> Class
…		…
990	urxvt::verbose 6, "register package $pkg to $self";	1039	urxvt::verbose 6, "register package $pkg to $self";
991		1040
992	@{"$pkg\::ISA"} = urxvt::term::extension::;	1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
993		1042
994	my $proxy = bless {	1043	my $proxy = bless {
995	_pkg => $pkg,	1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
996	argv => $argv,	1046	argv => $argv,
997	}, $pkg;	1047	}, $pkg;
998	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
999		1049
1000	$self->{_pkg}{$pkg} = $proxy;	1050	$self->{_pkg}{$pkg} = $proxy;
1001		1051
…		…
1004	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
1005	}	1055	}
1006	}	1056	}
1007	}	1057	}
1008		1058
		1059	sub perl_libdirs {
		1060	map { split /:/ }
		1061	$_[0]->resource ("perl_lib"),
		1062	$ENV{URXVT_PERL_LIB},
		1063	"$ENV{HOME}/.urxvt/ext",
		1064	"$LIBDIR/perl"
		1065	}
		1066
		1067	sub scan_meta {
		1068	my ($self) = @_;
		1069	my @libdirs = perl_libdirs $self;
		1070
		1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1072
		1073	my %meta;
		1074
		1075	$self->{meta_libdirs} = join "\x00", @libdirs;
		1076	$self->{meta} = \%meta;
		1077
		1078	for my $dir (reverse @libdirs) {
		1079	opendir my $fh, $dir
		1080	or next;
		1081	for my $ext (readdir $fh) {
		1082	$ext !~ /^\./
		1083	and open my $fh, "<", "$dir/$ext"
		1084	or next;
		1085
		1086	while (<$fh>) {
		1087	if (/^#:META:X_RESOURCE:(.*)/) {
		1088	my ($pattern, $type, $desc) = split /:/, $1;
		1089	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1090	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1091	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1092	} else {
		1093	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1094	}
		1095	} elsif (/^\s*(?:#|$)/) {
		1096	# skip other comments and empty lines
		1097	} else {
		1098	last; # stop parsing on first non-empty non-comment line
		1099	}
		1100	}
		1101	}
		1102	}
		1103	}
		1104
1009	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1105	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1010		1106
1011	Creates a new terminal, very similar as if you had started it with system	1107	Creates a new terminal, very similar as if you had started it with system
1012	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1108	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1013	hash which defines the environment of the new terminal.	1109	hash which defines the environment of the new terminal.
1014		1110
1015	Croaks (and probably outputs an error message) if the new instance	1111	Croaks (and probably outputs an error message) if the new instance
1016	couldn't be created. Returns C<undef> if the new instance didn't	1112	couldn't be created. Returns C<undef> if the new instance didn't
1017	initialise perl, and the terminal object otherwise. The C<init> and	1113	initialise perl, and the terminal object otherwise. The C<init> and
1018	C<start> hooks will be called during this call.	1114	C<start> hooks will be called before this call returns, and are free to
		1115	refer to global data (which is race free).
1019		1116
1020	=cut	1117	=cut
1021		1118
1022	sub new {	1119	sub new {
1023	my ($class, $env, @args) = @_;	1120	my ($class, $env, @args) = @_;
1024		1121
		1122	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1123	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1124
1025	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1125	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1026	}	1126	}
1027		1127
1028	=item $term->destroy	1128	=item $term->destroy
1029		1129
1030	Destroy the terminal object (close the window, free resources	1130	Destroy the terminal object (close the window, free resources
1031	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1131	etc.). Please note that urxvt will not exit as long as any event
1032	watchers (timers, io watchers) are still active.	1132	watchers (timers, io watchers) are still active.
1033		1133
1034	=item $term->exec_async ($cmd[, @args])	1134	=item $term->exec_async ($cmd[, @args])
1035		1135
1036	Works like the combination of the C<fork>/C<exec> builtins, which executes	1136	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1060		1160
1061	Returns true if the option specified by C<$optval> is enabled, and	1161	Returns true if the option specified by C<$optval> is enabled, and
1062	optionally change it. All option values are stored by name in the hash	1162	optionally change it. All option values are stored by name in the hash
1063	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1163	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1064		1164
1065	Here is a a likely non-exhaustive list of option names, please see the	1165	Here is a likely non-exhaustive list of option names, please see the
1066	source file F</src/optinc.h> to see the actual list:	1166	source file F</src/optinc.h> to see the actual list:
1067		1167
1068	borderLess console cursorBlink cursorUnderline hold iconic insecure	1168	borderLess buffered console cursorBlink cursorUnderline hold iconic
1069	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1169	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1070	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1170	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1071	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1171	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1072	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1172	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1073	transparent tripleclickwords utmpInhibit visualBell	1173	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1174	urgentOnBell utmpInhibit visualBell
1074		1175
1075	=item $value = $term->resource ($name[, $newval])	1176	=item $value = $term->resource ($name[, $newval])
1076		1177
1077	Returns the current resource value associated with a given name and	1178	Returns the current resource value associated with a given name and
1078	optionally sets a new value. Setting values is most useful in the C<init>	1179	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1087	likely change).	1188	likely change).
1088		1189
1089	Please note that resource strings will currently only be freed when the	1190	Please note that resource strings will currently only be freed when the
1090	terminal is destroyed, so changing options frequently will eat memory.	1191	terminal is destroyed, so changing options frequently will eat memory.
1091		1192
1092	Here is a a likely non-exhaustive list of resource names, not all of which	1193	Here is a likely non-exhaustive list of resource names, not all of which
1093	are supported in every build, please see the source file F</src/rsinc.h>	1194	are supported in every build, please see the source file F</src/rsinc.h>
1094	to see the actual list:	1195	to see the actual list:
1095		1196
1096	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1197	answerbackstring backgroundPixmap backspace_key blurradius
1097	borderLess color cursorBlink cursorUnderline cutchars delete_key	1198	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1098	display_name embed ext_bwidth fade font geometry hold iconName	1199	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1099	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1200	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1201	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1100	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1202	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1101	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1203	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1102	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1204	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1103	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1205	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1104	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1206	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1105	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1207	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1106	secondaryScreen secondaryScroll selectstyle shade term_name title	1208	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1107	transient_for transparent transparent_all tripleclickwords utmpInhibit	1209	term_name title transient_for transparent tripleclickwords urgentOnBell
1108	visualBell	1210	utmpInhibit visualBell
1109		1211
1110	=cut	1212	=cut
1111		1213
1112	sub resource($$;$) {	1214	sub resource($$;$) {
1113	my ($self, $name) = (shift, shift);	1215	my ($self, $name) = (shift, shift);
1114	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1216	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1115	&urxvt::term::_resource	1217	goto &urxvt::term::_resource
1116	}	1218	}
1117		1219
1118	=item $value = $term->x_resource ($pattern)	1220	=item $value = $term->x_resource ($pattern)
1119		1221
1120	Returns the X-Resource for the given pattern, excluding the program or	1222	Returns the X-Resource for the given pattern, excluding the program or
1121	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1223	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1122	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1224	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1123	resource with that pattern exists.	1225	resource with that pattern exists.
1124		1226
		1227	Extensions that define extra resource or command line arguments also need
		1228	to call this method to access their values.
		1229
		1230	If the method is called on an extension object (basically, from an
		1231	extension), then the special prefix C<%.> will be replaced by the name of
		1232	the extension and a dot, and the lone string C<%> will be replaced by the
		1233	extension name itself. This makes it possible to code extensions so you
		1234	can rename them and get a new set of commandline switches and resources
		1235	without having to change the actual code.
		1236
1125	This method should only be called during the C<on_start> hook, as there is	1237	This method should only be called during the C<on_start> hook, as there is
1126	only one resource database per display, and later invocations might return	1238	only one resource database per display, and later invocations might return
1127	the wrong resources.	1239	the wrong resources.
1128		1240
1129	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1241	=item $value = $term->x_resource_boolean ($pattern)
1130		1242
		1243	Like C<x_resource>, above, but interprets the string value as a boolean
		1244	and returns C<1> for true values, C<0> for false values and C<undef> if
		1245	the resource or option isn't specified.
		1246
		1247	You should always use this method to parse boolean resources.
		1248
		1249	=cut
		1250
		1251	sub x_resource_boolean {
		1252	my $res = &x_resource;
		1253
		1254	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1255	}
		1256
		1257	=item $success = $term->parse_keysym ($key, $octets)
		1258
1131	Adds a keymap translation exactly as specified via a resource. See the	1259	Adds a key binding exactly as specified via a resource. See the
1132	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1260	C<keysym> resource in the urxvt(1) manpage.
		1261
		1262	=item $term->register_command ($keysym, $modifiermask, $string)
		1263
		1264	Adds a key binding. This is a lower level api compared to
		1265	C<parse_keysym>, as it expects a parsed key description, and can be
		1266	used only inside either the C<on_init> hook, to add a binding, or the
		1267	C<on_register_command> hook, to modify a parsed binding.
1133		1268
1134	=item $rend = $term->rstyle ([$new_rstyle])	1269	=item $rend = $term->rstyle ([$new_rstyle])
1135		1270
1136	Return and optionally change the current rendition. Text that is output by	1271	Return and optionally change the current rendition. Text that is output by
1137	the terminal application will use this style.	1272	the terminal application will use this style.
…		…
1145		1280
1146	=item ($row, $col) = $term->selection_beg ([$row, $col])	1281	=item ($row, $col) = $term->selection_beg ([$row, $col])
1147		1282
1148	=item ($row, $col) = $term->selection_end ([$row, $col])	1283	=item ($row, $col) = $term->selection_end ([$row, $col])
1149		1284
1150	Return the current values of the selection mark, begin or end positions,	1285	Return the current values of the selection mark, begin or end positions.
1151	and optionally set them to new values.	1286
		1287	When arguments are given, then the selection coordinates are set to
		1288	C<$row> and C<$col>, and the selection screen is set to the current
		1289	screen.
		1290
		1291	=item $screen = $term->selection_screen ([$screen])
		1292
		1293	Returns the current selection screen, and then optionally sets it.
1152		1294
1153	=item $term->selection_make ($eventtime[, $rectangular])	1295	=item $term->selection_make ($eventtime[, $rectangular])
1154		1296
1155	Tries to make a selection as set by C<selection_beg> and	1297	Tries to make a selection as set by C<selection_beg> and
1156	C<selection_end>. If C<$rectangular> is true (default: false), a	1298	C<selection_end>. If C<$rectangular> is true (default: false), a
1157	rectangular selection will be made. This is the prefered function to make	1299	rectangular selection will be made. This is the preferred function to make
1158	a selection.	1300	a selection.
1159		1301
1160	=item $success = $term->selection_grab ($eventtime)	1302	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1161		1303
1162	Try to request the primary selection text from the server (for example, as	1304	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1305	true) selection from the server. The corresponding text can be set
1163	set by the next method). No visual feedback will be given. This function	1306	with the next method. No visual feedback will be given. This function
1164	is mostly useful from within C<on_sel_grab> hooks.	1307	is mostly useful from within C<on_sel_grab> hooks.
1165		1308
1166	=item $oldtext = $term->selection ([$newtext])	1309	=item $oldtext = $term->selection ([$newtext, $clipboard])
1167		1310
1168	Return the current selection text and optionally replace it by C<$newtext>.	1311	Return the current selection (clipboard if C<$clipboard> is true) text
		1312	and optionally replace it by C<$newtext>.
		1313
		1314	=item $term->selection_clear ([$clipboard])
		1315
		1316	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1169		1317
1170	=item $term->overlay_simple ($x, $y, $text)	1318	=item $term->overlay_simple ($x, $y, $text)
1171		1319
1172	Create a simple multi-line overlay box. See the next method for details.	1320	Create a simple multi-line overlay box. See the next method for details.
1173		1321
…		…
1203		1351
1204	The methods currently supported on C<urxvt::overlay> objects are:	1352	The methods currently supported on C<urxvt::overlay> objects are:
1205		1353
1206	=over 4	1354	=over 4
1207		1355
1208	=item $overlay->set ($x, $y, $text, $rend)	1356	=item $overlay->set ($x, $y, $text[, $rend])
1209		1357
1210	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1358	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1211	text in rxvt-unicode's special encoding and an array of rendition values	1359	text in rxvt-unicode's special encoding and an array of rendition values
1212	at a specific position inside the overlay.	1360	at a specific position inside the overlay.
		1361
		1362	If C<$rend> is missing, then the rendition will not be changed.
1213		1363
1214	=item $overlay->hide	1364	=item $overlay->hide
1215		1365
1216	If visible, hide the overlay, but do not destroy it.	1366	If visible, hide the overlay, but do not destroy it.
1217		1367
…		…
1299	locale-specific encoding of the terminal and can contain command sequences	1449	locale-specific encoding of the terminal and can contain command sequences
1300	(escape codes) that will be interpreted.	1450	(escape codes) that will be interpreted.
1301		1451
1302	=item $term->tt_write ($octets)	1452	=item $term->tt_write ($octets)
1303		1453
1304	Write the octets given in C<$data> to the tty (i.e. as program input). To	1454	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1305	pass characters instead of octets, you should convert your strings first	1455	pass characters instead of octets, you should convert your strings first
1306	to the locale-specific encoding using C<< $term->locale_encode >>.	1456	to the locale-specific encoding using C<< $term->locale_encode >>.
		1457
		1458	=item $term->tt_paste ($octets)
		1459
		1460	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1461	CR and bracketing the data with control sequences if bracketed paste mode
		1462	is set.
1307		1463
1308	=item $old_events = $term->pty_ev_events ([$new_events])	1464	=item $old_events = $term->pty_ev_events ([$new_events])
1309		1465
1310	Replaces the event mask of the pty watcher by the given event mask. Can	1466	Replaces the event mask of the pty watcher by the given event mask. Can
1311	be used to suppress input and output handling to the pty/tty. See the	1467	be used to suppress input and output handling to the pty/tty. See the
1312	description of C<< urxvt::timer->events >>. Make sure to always restore	1468	description of C<< urxvt::timer->events >>. Make sure to always restore
1313	the previous value.	1469	the previous value.
1314		1470
		1471	=item $fd = $term->pty_fd
		1472
		1473	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1474	is used.
		1475
1315	=item $windowid = $term->parent	1476	=item $windowid = $term->parent
1316		1477
1317	Return the window id of the toplevel window.	1478	Return the window id of the toplevel window.
1318		1479
1319	=item $windowid = $term->vt	1480	=item $windowid = $term->vt
…		…
1325	Adds the specified events to the vt event mask. Useful e.g. when you want	1486	Adds the specified events to the vt event mask. Useful e.g. when you want
1326	to receive pointer events all the times:	1487	to receive pointer events all the times:
1327		1488
1328	$term->vt_emask_add (urxvt::PointerMotionMask);	1489	$term->vt_emask_add (urxvt::PointerMotionMask);
1329		1490
		1491	=item $term->set_urgency ($set)
		1492
		1493	Enable/disable the urgency hint on the toplevel window.
		1494
		1495	=item $term->focus_in
		1496
		1497	=item $term->focus_out
		1498
		1499	=item $term->key_press ($state, $keycode[, $time])
		1500
		1501	=item $term->key_release ($state, $keycode[, $time])
		1502
		1503	Deliver various fake events to to terminal.
		1504
1330	=item $window_width = $term->width	1505	=item $window_width = $term->width
1331		1506
1332	=item $window_height = $term->height	1507	=item $window_height = $term->height
1333		1508
1334	=item $font_width = $term->fwidth	1509	=item $font_width = $term->fwidth
…		…
1364	=item $env = $term->env	1539	=item $env = $term->env
1365		1540
1366	Returns a copy of the environment in effect for the terminal as a hashref	1541	Returns a copy of the environment in effect for the terminal as a hashref
1367	similar to C<\%ENV>.	1542	similar to C<\%ENV>.
1368		1543
		1544	=item @envv = $term->envv
		1545
		1546	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1547
		1548	=item @argv = $term->argv
		1549
		1550	Return the argument vector as this terminal, similar to @ARGV, but
		1551	includes the program name as first element.
		1552
1369	=cut	1553	=cut
1370		1554
1371	sub env {	1555	sub env {
1372	if (my $env = $_[0]->_env) {
1373	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1556	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1374	} else {
1375	+{ %ENV }
1376	}
1377	}	1557	}
1378		1558
1379	=item $modifiermask = $term->ModLevel3Mask	1559	=item $modifiermask = $term->ModLevel3Mask
1380		1560
1381	=item $modifiermask = $term->ModMetaMask	1561	=item $modifiermask = $term->ModMetaMask
…		…
1389		1569
1390	Returns the currently displayed screen (0 primary, 1 secondary).	1570	Returns the currently displayed screen (0 primary, 1 secondary).
1391		1571
1392	=item $cursor_is_hidden = $term->hidden_cursor	1572	=item $cursor_is_hidden = $term->hidden_cursor
1393		1573
1394	Returns wether the cursor is currently hidden or not.	1574	Returns whether the cursor is currently hidden or not.
1395		1575
1396	=item $view_start = $term->view_start ([$newvalue])	1576	=item $view_start = $term->view_start ([$newvalue])
1397		1577
1398	Returns the row number of the topmost displayed line. Maximum value is	1578	Returns the row number of the topmost displayed line. Maximum value is
1399	C<0>, which displays the normal terminal contents. Lower values scroll	1579	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1407		1587
1408	Used after changing terminal contents to display them.	1588	Used after changing terminal contents to display them.
1409		1589
1410	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1590	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1411		1591
1412	Returns the text of the entire row with number C<$row_number>. Row C<0>	1592	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1413	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1593	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1414	terminal line. The scrollback buffer starts at line C<-1> and extends to
1415	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1594	terminal line. Nothing will be returned if a nonexistent line
1416	is requested.	1595	is requested.
1417		1596
1418	If C<$new_text> is specified, it will replace characters in the current	1597	If C<$new_text> is specified, it will replace characters in the current
1419	line, starting at column C<$start_col> (default C<0>), which is useful	1598	line, starting at column C<$start_col> (default C<0>), which is useful
1420	to replace only parts of a line. The font index in the rendition will	1599	to replace only parts of a line. The font index in the rendition will
1421	automatically be updated.	1600	automatically be updated.
1422		1601
1423	C<$text> is in a special encoding: tabs and wide characters that use more	1602	C<$text> is in a special encoding: tabs and wide characters that use more
1424	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1603	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1425	characters. Characters with combining characters and other characters that	1604	characters. Characters with combining characters and other characters that
1426	do not fit into the normal tetx encoding will be replaced with characters	1605	do not fit into the normal text encoding will be replaced with characters
1427	in the private use area.	1606	in the private use area.
1428		1607
1429	You have to obey this encoding when changing text. The advantage is	1608	You have to obey this encoding when changing text. The advantage is
1430	that C<substr> and similar functions work on screen cells and not on	1609	that C<substr> and similar functions work on screen cells and not on
1431	characters.	1610	characters.
…		…
1516	}	1695	}
1517		1696
1518	sub urxvt::line::t {	1697	sub urxvt::line::t {
1519	my ($self) = @_;	1698	my ($self) = @_;
1520		1699
1521	if (@_ > 1)	1700	if (@_ > 1) {
1522	{
1523	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1701	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1524	for $self->{beg} .. $self->{end};	1702	for $self->{beg} .. $self->{end};
1525	}	1703	}
1526		1704
1527	defined wantarray &&	1705	defined wantarray &&
1528	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1706	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1529	0, $self->{len}	1707	0, $self->{len}
1530	}	1708	}
1531		1709
1532	sub urxvt::line::r {	1710	sub urxvt::line::r {
1533	my ($self) = @_;	1711	my ($self) = @_;
1534		1712
1535	if (@_ > 1)	1713	if (@_ > 1) {
1536	{
1537	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1714	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1538	for $self->{beg} .. $self->{end};	1715	for $self->{beg} .. $self->{end};
1539	}	1716	}
1540		1717
1541	if (defined wantarray) {	1718	if (defined wantarray) {
1542	my $rend = [	1719	my $rend = [
1543	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1720	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1544	];	1721	];
…		…
1576	where one character corresponds to one screen cell. See	1753	where one character corresponds to one screen cell. See
1577	C<< $term->ROW_t >> for details.	1754	C<< $term->ROW_t >> for details.
1578		1755
1579	=item $string = $term->special_decode $text	1756	=item $string = $term->special_decode $text
1580		1757
1581	Converts rxvt-unicodes text reprsentation into a perl string. See	1758	Converts rxvt-unicodes text representation into a perl string. See
1582	C<< $term->ROW_t >> for details.	1759	C<< $term->ROW_t >> for details.
1583		1760
1584	=item $success = $term->grab_button ($button, $modifiermask)	1761	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1585		1762
		1763	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1764
1586	Registers a synchronous button grab. See the XGrabButton manpage.	1765	Register/unregister a synchronous button grab. See the XGrabButton
		1766	manpage.
1587		1767
1588	=item $success = $term->grab ($eventtime[, $sync])	1768	=item $success = $term->grab ($eventtime[, $sync])
1589		1769
1590	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1770	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1591	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1771	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1592		1772
1593	=item $term->allow_events_async	1773	=item $term->allow_events_async
1594		1774
1595	Calls XAllowEvents with AsyncBoth for the most recent grab.	1775	Calls XAllowEvents with AsyncBoth for the most recent grab.
1596		1776
…		…
1603	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1783	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1604	recent grab.	1784	recent grab.
1605		1785
1606	=item $term->ungrab	1786	=item $term->ungrab
1607		1787
1608	Calls XUngrab for the most recent grab. Is called automatically on	1788	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1609	evaluation errors, as it is better to lose the grab in the error case as	1789	evaluation errors, as it is better to lose the grab in the error case as
1610	the session.	1790	the session.
1611		1791
1612	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1792	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1613		1793
…		…
1615		1795
1616	=item @atoms = $term->XListProperties ($window)	1796	=item @atoms = $term->XListProperties ($window)
1617		1797
1618	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1798	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1619		1799
1620	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1800	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1621		1801
1622	=item $term->XDeleteProperty ($window, $property)	1802	=item $term->XDeleteProperty ($window, $property)
1623		1803
1624	=item $window = $term->DefaultRootWindow	1804	=item $window = $term->DefaultRootWindow
1625		1805
…		…
1632	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1812	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1633		1813
1634	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1814	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1635		1815
1636	=item $term->XChangeInput ($window, $add_events[, $del_events])	1816	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1817
		1818	=item $keysym = $term->XStringToKeysym ($string)
		1819
		1820	=item $string = $term->XKeysymToString ($keysym)
1637		1821
1638	Various X or X-related functions. The C<$term> object only serves as	1822	Various X or X-related functions. The C<$term> object only serves as
1639	the source of the display, otherwise those functions map more-or-less	1823	the source of the display, otherwise those functions map more-or-less
1640	directory onto the X functions of the same name.	1824	directly onto the X functions of the same name.
1641		1825
1642	=back	1826	=back
1643		1827
1644	=cut	1828	=cut
1645		1829
…		…
1709	my ($self, $text, $cb) = @_;	1893	my ($self, $text, $cb) = @_;
1710		1894
1711	$self->add_item ({ type => "button", text => $text, activate => $cb});	1895	$self->add_item ({ type => "button", text => $text, activate => $cb});
1712	}	1896	}
1713		1897
1714	=item $popup->add_toggle ($text, $cb, $initial_value)	1898	=item $popup->add_toggle ($text, $initial_value, $cb)
1715		1899
1716	Adds a toggle/checkbox item to the popup. Teh callback gets called	1900	Adds a toggle/checkbox item to the popup. The callback gets called
1717	whenever it gets toggled, with a boolean indicating its value as its first	1901	whenever it gets toggled, with a boolean indicating its new value as its
1718	argument.	1902	first argument.
1719		1903
1720	=cut	1904	=cut
1721		1905
1722	sub add_toggle {	1906	sub add_toggle {
1723	my ($self, $text, $cb, $value) = @_;	1907	my ($self, $text, $value, $cb) = @_;
1724		1908
1725	my $item; $item = {	1909	my $item; $item = {
1726	type => "button",	1910	type => "button",
1727	text => " $text",	1911	text => " $text",
1728	value => $value,	1912	value => $value,
…		…
1747	my $env = $self->{term}->env;	1931	my $env = $self->{term}->env;
1748	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1932	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1749	delete $env->{LC_ALL};	1933	delete $env->{LC_ALL};
1750	$env->{LC_CTYPE} = $self->{term}->locale;	1934	$env->{LC_CTYPE} = $self->{term}->locale;
1751		1935
1752	urxvt::term->new ($env, "popup",	1936	my $term = urxvt::term->new (
		1937	$env, "popup",
1753	"--perl-lib" => "", "--perl-ext-common" => "",	1938	"--perl-lib" => "", "--perl-ext-common" => "",
1754	"-pty-fd" => -1, "-sl" => 0,	1939	"-pty-fd" => -1, "-sl" => 0,
1755	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1940	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1756	"--transient-for" => $self->{term}->parent,	1941	"--transient-for" => $self->{term}->parent,
1757	"-display" => $self->{term}->display_id,	1942	"-display" => $self->{term}->display_id,
1758	"-pe" => "urxvt-popup")	1943	"-pe" => "urxvt-popup",
1759	or die "unable to create popup window\n";	1944	) or die "unable to create popup window\n";
		1945
		1946	unless (delete $term->{urxvt_popup_init_done}) {
		1947	$term->ungrab;
		1948	$term->destroy;
		1949	die "unable to initialise popup window\n";
		1950	}
1760	}	1951	}
1761		1952
1762	sub DESTROY {	1953	sub DESTROY {
1763	my ($self) = @_;	1954	my ($self) = @_;
1764		1955
…		…
1769	=back	1960	=back
1770		1961
1771	=cut	1962	=cut
1772		1963
1773	package urxvt::watcher;	1964	package urxvt::watcher;
1774
1775	@urxvt::timer::ISA = __PACKAGE__;
1776	@urxvt::iow::ISA = __PACKAGE__;
1777	@urxvt::pw::ISA = __PACKAGE__;
1778	@urxvt::iw::ISA = __PACKAGE__;
1779		1965
1780	=head2 The C<urxvt::timer> Class	1966	=head2 The C<urxvt::timer> Class
1781		1967
1782	This class implements timer watchers/events. Time is represented as a	1968	This class implements timer watchers/events. Time is represented as a
1783	fractional number of seconds since the epoch. Example:	1969	fractional number of seconds since the epoch. Example:
…		…
1787	->new	1973	->new
1788	->interval (1)	1974	->interval (1)
1789	->cb (sub {	1975	->cb (sub {
1790	$term->{overlay}->set (0, 0,	1976	$term->{overlay}->set (0, 0,
1791	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1977	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1792	});	1978	});
1793		1979
1794	=over 4	1980	=over 4
1795		1981
1796	=item $timer = new urxvt::timer	1982	=item $timer = new urxvt::timer
1797		1983
…		…
1800		1986
1801	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1987	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1802		1988
1803	Set the callback to be called when the timer triggers.	1989	Set the callback to be called when the timer triggers.
1804		1990
1805	=item $tstamp = $timer->at
1806
1807	Return the time this watcher will fire next.
1808
1809	=item $timer = $timer->set ($tstamp)	1991	=item $timer = $timer->set ($tstamp[, $interval])
1810		1992
1811	Set the time the event is generated to $tstamp.	1993	Set the time the event is generated to $tstamp (and optionally specifies a
		1994	new $interval).
1812		1995
1813	=item $timer = $timer->interval ($interval)	1996	=item $timer = $timer->interval ($interval)
1814		1997
1815	Normally (and when C<$interval> is C<0>), the timer will automatically	1998	By default (and when C<$interval> is C<0>), the timer will automatically
1816	stop after it has fired once. If C<$interval> is non-zero, then the timer	1999	stop after it has fired once. If C<$interval> is non-zero, then the timer
1817	is automatically rescheduled at the given intervals.	2000	is automatically rescheduled at the given intervals.
1818		2001
1819	=item $timer = $timer->start	2002	=item $timer = $timer->start
1820		2003
1821	Start the timer.	2004	Start the timer.
1822		2005
1823	=item $timer = $timer->start ($tstamp)	2006	=item $timer = $timer->start ($tstamp[, $interval])
1824		2007
1825	Set the event trigger time to C<$tstamp> and start the timer.	2008	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2009	also replaces the interval.
1826		2010
1827	=item $timer = $timer->after ($delay)	2011	=item $timer = $timer->after ($delay[, $interval])
1828		2012
1829	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2013	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1830		2014
1831	=item $timer = $timer->stop	2015	=item $timer = $timer->stop
1832		2016
…		…
1840		2024
1841	$term->{socket} = ...	2025	$term->{socket} = ...
1842	$term->{iow} = urxvt::iow	2026	$term->{iow} = urxvt::iow
1843	->new	2027	->new
1844	->fd (fileno $term->{socket})	2028	->fd (fileno $term->{socket})
1845	->events (urxvt::EVENT_READ)	2029	->events (urxvt::EV_READ)
1846	->start	2030	->start
1847	->cb (sub {	2031	->cb (sub {
1848	my ($iow, $revents) = @_;	2032	my ($iow, $revents) = @_;
1849	# $revents must be 1 here, no need to check	2033	# $revents must be 1 here, no need to check
1850	sysread $term->{socket}, my $buf, 8192	2034	sysread $term->{socket}, my $buf, 8192
…		…
1863	Set the callback to be called when io events are triggered. C<$reventmask>	2047	Set the callback to be called when io events are triggered. C<$reventmask>
1864	is a bitset as described in the C<events> method.	2048	is a bitset as described in the C<events> method.
1865		2049
1866	=item $iow = $iow->fd ($fd)	2050	=item $iow = $iow->fd ($fd)
1867		2051
1868	Set the filedescriptor (not handle) to watch.	2052	Set the file descriptor (not handle) to watch.
1869		2053
1870	=item $iow = $iow->events ($eventmask)	2054	=item $iow = $iow->events ($eventmask)
1871		2055
1872	Set the event mask to watch. The only allowed values are	2056	Set the event mask to watch. The only allowed values are
1873	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2057	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1874	together, or C<urxvt::EVENT_NONE>.	2058	together, or C<urxvt::EV_NONE>.
1875		2059
1876	=item $iow = $iow->start	2060	=item $iow = $iow->start
1877		2061
1878	Start watching for requested events on the given handle.	2062	Start watching for requested events on the given handle.
1879		2063
1880	=item $iow = $iow->stop	2064	=item $iow = $iow->stop
1881		2065
1882	Stop watching for events on the given filehandle.	2066	Stop watching for events on the given file handle.
1883		2067
1884	=back	2068	=back
1885		2069
1886	=head2 The C<urxvt::iw> Class	2070	=head2 The C<urxvt::iw> Class
1887		2071
…		…
1920	->new	2104	->new
1921	->start ($pid)	2105	->start ($pid)
1922	->cb (sub {	2106	->cb (sub {
1923	my ($pw, $exit_status) = @_;	2107	my ($pw, $exit_status) = @_;
1924	...	2108	...
1925	});	2109	});
1926		2110
1927	=over 4	2111	=over 4
1928		2112
1929	=item $pw = new urxvt::pw	2113	=item $pw = new urxvt::pw
1930		2114
…		…
1934		2118
1935	Set the callback to be called when the timer triggers.	2119	Set the callback to be called when the timer triggers.
1936		2120
1937	=item $pw = $timer->start ($pid)	2121	=item $pw = $timer->start ($pid)
1938		2122
1939	Tells the wqtcher to start watching for process C<$pid>.	2123	Tells the watcher to start watching for process C<$pid>.
1940		2124
1941	=item $pw = $pw->stop	2125	=item $pw = $pw->stop
1942		2126
1943	Stop the watcher.	2127	Stop the watcher.
1944		2128
…		…
1957		2141
1958	=item >= 3 - script loading and management	2142	=item >= 3 - script loading and management
1959		2143
1960	=item >=10 - all called hooks	2144	=item >=10 - all called hooks
1961		2145
1962	=item >=11 - hook reutrn values	2146	=item >=11 - hook return values
1963		2147
1964	=back	2148	=back
1965		2149
1966	=head1 AUTHOR	2150	=head1 AUTHOR
1967		2151
1968	Marc Lehmann <pcg@goof.com>	2152	Marc Lehmann <schmorp@schmorp.de>
1969	http://software.schmorp.de/pkg/rxvt-unicode	2153	http://software.schmorp.de/pkg/rxvt-unicode
1970		2154
1971	=cut	2155	=cut
1972		2156
1973	1	2157	1
		2158
		2159	# vim: sw=3:

Diff Legend

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