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.113 by root, Fri Jan 20 10:27:08 2006 UTC vs.
Revision 1.227 by root, Sun Mar 31 20:30:32 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	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 mark-urls
168
169	Uses per-line display filtering (C<on_line_update>) to underline urls and
170	make them clickable. When middle-clicked, the program specified in the
171	resource C<urlLauncher> (default C<x-www-browser>) will be started with
172	the URL as first argument.
173
174	=item automove-background
175
176	This is basically a one-line extension that dynamically changes the background pixmap offset
177	to the window position, in effect creating the same effect as pseudo transparency with
178	a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
181
182	=item block-graphics-to-ascii
183
184	A not very useful example of filtering all text output to the terminal,
185	by replacing all line-drawing characters (U+2500 .. U+259F) by a
186	similar-looking ascii character.
187
188	=item digital-clock
189
190	Displays a digital clock using the built-in overlay.
191
192	=item example-refresh-hooks
193
194	Displays a very simple digital clock in the upper right corner of the
195	window. Illustrates overwriting the refresh callbacks to create your own
196	overlays or changes.
197
198	=item selection-pastebin
199
200	This is a little rarely useful extension that Uploads the selection as
201	textfile to a remote site (or does other things). (The implementation is
202	not currently secure for use in a multiuser environment as it writes to
203	F</tmp> directly.).
204
205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206	i.e.
207
208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210	Pressing this combination runs a command with C<%> replaced by the name of
211	the textfile. This command can be set via a resource:
212
213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215	And the default is likely not useful to anybody but the few people around
216	here :)
217
218	The name of the textfile is the hex encoded md5 sum of the selection, so
219	the same content should lead to the same filename.
220
221	After a successful upload the selection will be replaced by the text given
222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
223	for the filename):
224
225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
226
227	=back
228		50
229	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
230		52
231	=head2 General API Considerations	53	=head2 General API Considerations
232		54
…		…
246		68
247	=over 4	69	=over 4
248		70
249	=item $text	71	=item $text
250		72
251	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
252	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.
253		75
254	=item $string	76	=item $string
255		77
256	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
…		…
260	=item $octets	82	=item $octets
261		83
262	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
263	locale-specific way.	85	locale-specific way.
264		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
265	=back	93	=back
266		94
267	=head2 Extension Objects	95	=head2 Extension Objects
268		96
269	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
270	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,
271	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
272	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
273	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
274	use.	103	internal use.
275		104
276	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
277	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
278		107
279	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
280		109	the C<urxvt::extension> section below.
281	=over 4
282
283	=item $urxvt_term = $self->{term}
284
285	Returns the C<urxvt::term> object associated with this instance of the
286	extension. This member I<must not> be changed in any way.
287
288	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
289
290	Dynamically enable the given hooks (named without the C<on_> prefix) for
291	this extension, replacing any previous hook. This is useful when you want
292	to overwrite time-critical hooks only temporarily.
293
294	=item $self->disable ($hook_name[, $hook_name..])
295
296	Dynamically disable the given hooks.
297
298	=back
299		110
300	=head2 Hooks	111	=head2 Hooks
301		112
302	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
303	called whenever the relevant event happens.	114	called whenever the relevant event happens.
304		115
305	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
306	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
307		118
308	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
309	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
310	relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
…		…
323	place.	134	place.
324		135
325	=item on_start $term	136	=item on_start $term
326		137
327	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
328	trying to map (display) the toplevel and returning to the mainloop.	139	trying to map (display) the toplevel and returning to the main loop.
329		140
330	=item on_destroy $term	141	=item on_destroy $term
331		142
332	Called whenever something tries to destroy terminal, before doing anything	143	Called whenever something tries to destroy terminal, when the terminal is
333	yet. If this hook returns true, then destruction is skipped, but this is	144	still fully functional (not for long, though).
334	rarely a good idea.
335		145
336	=item on_reset $term	146	=item on_reset $term
337		147
338	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
339	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
…		…
361		171
362	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
363	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
364	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
365		175
366	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.
367		177
368	=item on_sel_extend $term	178	=item on_sel_extend $term
369		179
370	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
371	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
372	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
373	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
374	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
375	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
376		186
377	See the F<selection> example extension.	187	See the F<selection> example extension.
378		188
379	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
380		190
381	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
382	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
383	show this many lines of scrollback.	193	show this many lines of scrollback.
384		194
385	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
386		196
…		…
390		200
391	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,
392	$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
393	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
394		204
395	=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
396		216
397	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
398	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
399	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
400	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,
401	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
402	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	}
403		233
404	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,
405	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
406	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.
407		240
408	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
409		242
410	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
411	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
…		…
416	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
417		250
418	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
419	suppress or filter tty input.	252	suppress or filter tty input.
420		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
421	=item on_line_update $term, $row	261	=item on_line_update $term, $row
422		262
423	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
424	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
425	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,
…		…
432	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
433	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
434		274
435	=item on_refresh_begin $term	275	=item on_refresh_begin $term
436		276
437	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
438	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
439	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
440	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
441		281
442	=item on_refresh_end $term	282	=item on_refresh_end $term
443		283
444	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>.
445		285
446	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string
447		287
448	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
449	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>
450	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.
451		307
452	=item on_x_event $term, $event	308	=item on_x_event $term, $event
453		309
454	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
455	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
456	members are not passed.	312	members are not passed.
457		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
458	=item on_focus_in $term	318	=item on_focus_in $term
459		319
460	Called whenever the window gets the keyboard focus, before rxvt-unicode	320	Called whenever the window gets the keyboard focus, before rxvt-unicode
461	does focus in processing.	321	does focus in processing.
462		322
463	=item on_focus_out $term	323	=item on_focus_out $term
464		324
465	Called wheneever the window loses keyboard focus, before rxvt-unicode does	325	Called whenever the window loses keyboard focus, before rxvt-unicode does
466	focus out processing.	326	focus out processing.
467		327
468	=item on_configure_notify $term, $event	328	=item on_configure_notify $term, $event
469		329
		330	=item on_property_notify $term, $event
		331
470	=item on_key_press $term, $event, $keysym, $octets	332	=item on_key_press $term, $event, $keysym, $octets
471		333
472	=item on_key_release $term, $event, $keysym	334	=item on_key_release $term, $event, $keysym
473		335
474	=item on_button_press $term, $event	336	=item on_button_press $term, $event
…		…
479		341
480	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
481		343
482	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
483		345
484	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
485	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.
486		348
487	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
488	manpage), with the additional members C<row> and C<col>, which are the row	350	manpage), with the additional members C<row> and C<col>, which are the
489	and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
490		352
491	C<on_key_press> additionally receives the string rxvt-unicode would	353	C<on_key_press> additionally receives the string rxvt-unicode would
492	output, if any, in locale-specific encoding.	354	output, if any, in locale-specific encoding.
493		355
494	subwindow.	356	subwindow.
495		357
		358	=item on_client_message $term, $event
		359
		360	=item on_wm_protocols $term, $event
		361
		362	=item on_wm_delete_window $term, $event
		363
		364	Called when various types of ClientMessage events are received (all with
		365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
496	=back	371	=back
497		372
498	=cut	373	=cut
499		374
500	package urxvt;	375	package urxvt;
501		376
502	use utf8;	377	use utf8;
503	use strict;	378	use strict 'vars';
504	use Carp ();	379	use Carp ();
505	use Scalar::Util ();	380	use Scalar::Util ();
506	use List::Util ();	381	use List::Util ();
507		382
508	our $VERSION = 1;	383	our $VERSION = 1;
509	our $TERM;	384	our $TERM;
510	our @TERM_INIT;	385	our @TERM_INIT; # should go, prevents async I/O etc.
511	our @TERM_EXT;	386	our @TERM_EXT; # should go, prevents async I/O etc.
512	our @HOOKNAME;	387	our @HOOKNAME;
513	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
514	our %OPTION;	389	our %OPTION;
515		390
516	our $LIBDIR;	391	our $LIBDIR;
517	our $RESNAME;	392	our $RESNAME;
518	our $RESCLASS;	393	our $RESCLASS;
519	our $RXVTNAME;	394	our $RXVTNAME;
520		395
		396	our $NOCHAR = chr 0xffff;
		397
521	=head2 Variables in the C<urxvt> Package	398	=head2 Variables in the C<urxvt> Package
522		399
523	=over 4	400	=over 4
524		401
525	=item $urxvt::LIBDIR	402	=item $urxvt::LIBDIR
…		…
540	The current terminal. This variable stores the current C<urxvt::term>	417	The current terminal. This variable stores the current C<urxvt::term>
541	object, whenever a callback/hook is executing.	418	object, whenever a callback/hook is executing.
542		419
543	=item @urxvt::TERM_INIT	420	=item @urxvt::TERM_INIT
544		421
545	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
546	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
547	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,
548	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.
549		426
550	This complements to the perl-eval commandline option, but gets executed	427	This complements to the perl-eval command line option, but gets executed
551	first.	428	first.
552		429
553	=item @urxvt::TERM_EXT	430	=item @urxvt::TERM_EXT
554		431
555	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
…		…
562		439
563	=over 4	440	=over 4
564		441
565	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
566		443
567	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
568	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
569	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
570		448
571	=item urxvt::warn $string	449	=item urxvt::warn $string
572		450
573	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
574	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
575	that calls this function.	453	that calls this function.
576		454
577	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
578	correct place, e.g. on stderr of the connecting urxvtc client.	456	correct place, e.g. on stderr of the connecting urxvtc client.
579		457
580	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).
581		466
582	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
583		468
584	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
585		470
…		…
628		513
629	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
630		515
631	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
632		517
633	=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
634		520
635	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
636	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
637	the bitset.	523	the bitset.
638		524
…		…
643	Return the foreground/background colour index, respectively.	529	Return the foreground/background colour index, respectively.
644		530
645	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	531	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
646		532
647	=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
648		536
649	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
650	specified one.	538	specified one.
651		539
652	=item $value = urxvt::GET_CUSTOM $rend	540	=item $value = urxvt::GET_CUSTOM $rend
…		…
671	unless $msg =~ /\n$/;	559	unless $msg =~ /\n$/;
672	urxvt::warn ($msg);	560	urxvt::warn ($msg);
673	};	561	};
674	}	562	}
675		563
		564	no warnings 'utf8';
		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; # reste 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
676	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
677		627
678	sub verbose {	628	sub verbose {
679	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
680	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
…		…
692	$pkg =~ s/[^[:word:]]/_/g;	642	$pkg =~ s/[^[:word:]]/_/g;
693	$pkg = "urxvt::ext::$pkg";	643	$pkg = "urxvt::ext::$pkg";
694		644
695	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
696		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		648
697	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
698	or die "$path: $!";	650	or die "$path: $!";
699		651
700	my $source =	652	my $source =
701	"package $pkg; use strict; use utf8;\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
702	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
703	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
704	. "\n};\n1";	656	. "\n};\n1";
705		657
706	eval $source	658	eval $source
…		…
716	sub invoke {	668	sub invoke {
717	local $TERM = shift;	669	local $TERM = shift;
718	my $htype = shift;	670	my $htype = shift;
719		671
720	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
721	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
722		674
723	my %ext_arg;	675	my %ext_arg;
724		676
725	{	677	{
726	my @init = @TERM_INIT;	678	my @init = @TERM_INIT;
727	@TERM_INIT = ();	679	@TERM_INIT = ();
…		…
729	my @pkg = @TERM_EXT;	681	my @pkg = @TERM_EXT;
730	@TERM_EXT = ();	682	@TERM_EXT = ();
731	$TERM->register_package ($_) for @pkg;	683	$TERM->register_package ($_) for @pkg;
732	}	684	}
733		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
734	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
735	if ($_ eq "default") {	690	if ($_ eq "default") {
736	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	691	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
737	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
738	delete $ext_arg{$1};	693	delete $ext_arg{$1};
739	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
740	push @{ $ext_arg{$1} }, $2;	695	push @{ $ext_arg{$1} }, $2;
741	} else {	696	} else {
742	$ext_arg{$_} ||= [];	697	$ext_arg{$_} ||= [];
743	}	698	}
744	}	699	}
745		700
746	while (my ($ext, $argv) = each %ext_arg) {	701	for my $ext (sort keys %ext_arg) {
747	my @files = grep -f $_, map "$_/$ext", @dirs;	702	my @files = grep -f $_, map "$_/$ext", @dirs;
748		703
749	if (@files) {	704	if (@files) {
750	$TERM->register_package (extension_package $files[0], $argv);	705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
751	} else {	706	} else {
752	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";
753	}	708	}
754	}	709	}
755		710
…		…
761		716
762	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
763	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
764	if $verbosity >= 10;	719	if $verbosity >= 10;
765		720
766	keys %$cb;	721	for my $pkg (keys %$cb) {
767
768	while (my ($pkg, $cb) = each %$cb) {
769	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
770	$retval ||= $retval_;	723	$retval ||= $retval_;
771		724
772	if ($@) {	725	if ($@) {
773	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
774	warn $@;	727	warn $@;
…		…
788	}	741	}
789		742
790	$retval	743	$retval
791	}	744	}
792		745
793	# 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	}
794		774
795	package urxvt::term::extension;	775	package urxvt::term::extension;
796		776
797	sub enable {	777	=head2 The C<urxvt::term::extension> class
798	my ($self, %hook) = @_;
799	my $pkg = $self->{_pkg};
800		778
801	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
802	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
803	defined $htype
804	or Carp::croak "unsupported hook type '$name'";
805		781
806	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
807	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
808		784
809	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
810	}	786	objects, in addition to call methods documented for the <urxvt::term>
811	}	787	class.
812		788
813	sub disable {	789	=over 4
814	my ($self, @hook) = @_;
815	my $pkg = $self->{_pkg};
816		790
817	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
818	my $htype = $HOOKTYPE{uc $name};
819	defined $htype
820	or Carp::croak "unsupported hook type '$name'";
821		792
822	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
823	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
824	}	795
825	}	796	=cut
826		797
827	our $AUTOLOAD;	798	our $AUTOLOAD;
828		799
829	sub AUTOLOAD {	800	sub AUTOLOAD {
830	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
843		814
844	sub DESTROY {	815	sub DESTROY {
845	# nop	816	# nop
846	}	817	}
847		818
848	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
849		820
850	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
851	${$_[0]}->();	822	${$_[0]}->();
852	}	823	}
853		824
854	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
855	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
856	}	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
857		939
858	package urxvt::anyevent;	940	package urxvt::anyevent;
859		941
860	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
861		943
862	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
863	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
864	further programming. The only exception is that you cannot wait on	946	further programming. The only exception is that you cannot wait on
865	condition variables, but non-blocking condvar use is ok. What this means	947	condition variables, but non-blocking condvar use is ok.
866	is that you cannot use blocking APIs, but the non-blocking variant should
867	work.
868		948
869	=cut	949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
870		951
		952	=cut
		953
871	our $VERSION = 1;	954	our $VERSION = '5.23';
872		955
873	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	956	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
874	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	957	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
875		958
876	sub timer {	959	sub timer {
…		…
878		961
879	my $cb = $arg{cb};	962	my $cb = $arg{cb};
880		963
881	urxvt::timer	964	urxvt::timer
882	->new	965	->new
883	->start (urxvt::NOW + $arg{after})	966	->after ($arg{after}, $arg{interval})
884	->cb (sub {	967	->cb ($arg{interval} ? $cb : sub {
885	$_[0]->stop; # need to cancel manually	968	$_[0]->stop; # need to cancel manually
886	$cb->();	969	$cb->();
887	})	970	})
888	}	971	}
889		972
890	sub io {	973	sub io {
891	my ($class, %arg) = @_;	974	my ($class, %arg) = @_;
892		975
893	my $cb = $arg{cb};	976	my $cb = $arg{cb};
		977	my $fd = fileno $arg{fh};
		978	defined $fd or $fd = $arg{fh};
894		979
895	bless [$arg{fh}, urxvt::iow	980	bless [$arg{fh}, urxvt::iow
896	->new	981	->new
897	->fd (fileno $arg{fh})	982	->fd ($fd)
898	->events (($arg{poll} =~ /r/ ? 1 : 0)	983	->events (($arg{poll} =~ /r/ ? 1 : 0)
899	| ($arg{poll} =~ /w/ ? 2 : 0))	984	| ($arg{poll} =~ /w/ ? 2 : 0))
900	->start	985	->start
901	->cb (sub {	986	->cb ($cb)
902	$cb->(($_[1] & 1 ? 'r' : '')
903	. ($_[1] & 2 ? 'w' : ''));
904	})],
905	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	})
906	}	1013	}
907		1014
908	sub DESTROY {	1015	sub DESTROY {
909	$_[0][1]->stop;	1016	$_[0][1]->stop;
910	}	1017	}
911		1018
912	sub condvar {	1019	# only needed for AnyEvent < 6 compatibility
913	bless \my $flag, urxvt::anyevent::condvar::	1020	sub one_event {
914	}
915
916	sub urxvt::anyevent::condvar::broadcast {
917	${$_[0]}++;
918	}
919
920	sub urxvt::anyevent::condvar::wait {
921	unless (${$_[0]}) {
922	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";
923	}
924	}	1022	}
925		1023
926	package urxvt::term;	1024	package urxvt::term;
927		1025
928	=head2 The C<urxvt::term> Class	1026	=head2 The C<urxvt::term> Class
…		…
941	urxvt::verbose 6, "register package $pkg to $self";	1039	urxvt::verbose 6, "register package $pkg to $self";
942		1040
943	@{"$pkg\::ISA"} = urxvt::term::extension::;	1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
944		1042
945	my $proxy = bless {	1043	my $proxy = bless {
946	_pkg => $pkg,	1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
947	argv => $argv,	1046	argv => $argv,
948	}, $pkg;	1047	}, $pkg;
949	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
950		1049
951	$self->{_pkg}{$pkg} = $proxy;	1050	$self->{_pkg}{$pkg} = $proxy;
952		1051
…		…
955	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
956	}	1055	}
957	}	1056	}
958	}	1057	}
959		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
960	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1105	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
961		1106
962	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
963	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
964	hash which defines the environment of the new terminal.	1109	hash which defines the environment of the new terminal.
965		1110
966	Croaks (and probably outputs an error message) if the new instance	1111	Croaks (and probably outputs an error message) if the new instance
967	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
968	initialise perl, and the terminal object otherwise. The C<init> and	1113	initialise perl, and the terminal object otherwise. The C<init> and
969	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).
970		1116
971	=cut	1117	=cut
972		1118
973	sub new {	1119	sub new {
974	my ($class, $env, @args) = @_;	1120	my ($class, $env, @args) = @_;
975		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
976	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1125	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
977	}	1126	}
978		1127
979	=item $term->destroy	1128	=item $term->destroy
980		1129
981	Destroy the terminal object (close the window, free resources	1130	Destroy the terminal object (close the window, free resources
982	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
983	watchers (timers, io watchers) are still active.	1132	watchers (timers, io watchers) are still active.
984		1133
985	=item $term->exec_async ($cmd[, @args])	1134	=item $term->exec_async ($cmd[, @args])
986		1135
987	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
…		…
1011		1160
1012	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
1013	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
1014	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.
1015		1164
1016	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
1017	source file F</src/optinc.h> to see the actual list:	1166	source file F</src/optinc.h> to see the actual list:
1018		1167
1019	borderLess console cursorBlink cursorUnderline hold iconic insecure	1168	borderLess buffered console cursorBlink cursorUnderline hold iconic
1020	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1169	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1021	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1170	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1022	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1171	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1023	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1172	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1024	transparent tripleclickwords utmpInhibit visualBell	1173	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1174	urgentOnBell utmpInhibit visualBell
1025		1175
1026	=item $value = $term->resource ($name[, $newval])	1176	=item $value = $term->resource ($name[, $newval])
1027		1177
1028	Returns the current resource value associated with a given name and	1178	Returns the current resource value associated with a given name and
1029	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>
…		…
1038	likely change).	1188	likely change).
1039		1189
1040	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
1041	terminal is destroyed, so changing options frequently will eat memory.	1191	terminal is destroyed, so changing options frequently will eat memory.
1042		1192
1043	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
1044	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>
1045	to see the actual list:	1195	to see the actual list:
1046		1196
1047	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1197	answerbackstring backgroundPixmap backspace_key blurradius
1048	borderLess color cursorBlink cursorUnderline cutchars delete_key	1198	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1049	display_name embed ext_bwidth fade font geometry hold iconName	1199	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1050	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
1051	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1202	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1052	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1203	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1053	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1204	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1054	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1205	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1055	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1206	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1056	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1207	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1057	secondaryScreen secondaryScroll selectstyle shade term_name title	1208	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1058	transient_for transparent transparent_all tripleclickwords utmpInhibit	1209	term_name title transient_for transparent tripleclickwords urgentOnBell
1059	visualBell	1210	utmpInhibit visualBell
1060		1211
1061	=cut	1212	=cut
1062		1213
1063	sub resource($$;$) {	1214	sub resource($$;$) {
1064	my ($self, $name) = (shift, shift);	1215	my ($self, $name) = (shift, shift);
1065	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1216	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1066	&urxvt::term::_resource	1217	goto &urxvt::term::_resource
1067	}	1218	}
1068		1219
1069	=item $value = $term->x_resource ($pattern)	1220	=item $value = $term->x_resource ($pattern)
1070		1221
1071	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
1072	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
1073	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
1074	resource with that pattern exists.	1225	resource with that pattern exists.
1075		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
1076	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
1077	only one resource database per display, and later invocations might return	1238	only one resource database per display, and later invocations might return
1078	the wrong resources.	1239	the wrong resources.
1079		1240
1080	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1241	=item $value = $term->x_resource_boolean ($pattern)
1081		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
1082	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
1083	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.
1084		1268
1085	=item $rend = $term->rstyle ([$new_rstyle])	1269	=item $rend = $term->rstyle ([$new_rstyle])
1086		1270
1087	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
1088	the terminal application will use this style.	1272	the terminal application will use this style.
…		…
1096		1280
1097	=item ($row, $col) = $term->selection_beg ([$row, $col])	1281	=item ($row, $col) = $term->selection_beg ([$row, $col])
1098		1282
1099	=item ($row, $col) = $term->selection_end ([$row, $col])	1283	=item ($row, $col) = $term->selection_end ([$row, $col])
1100		1284
1101	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.
1102	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.
1103		1294
1104	=item $term->selection_make ($eventtime[, $rectangular])	1295	=item $term->selection_make ($eventtime[, $rectangular])
1105		1296
1106	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
1107	C<selection_end>. If C<$rectangular> is true (default: false), a	1298	C<selection_end>. If C<$rectangular> is true (default: false), a
1108	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
1109	a selection.	1300	a selection.
1110		1301
1111	=item $success = $term->selection_grab ($eventtime)	1302	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1112		1303
1113	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
1114	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
1115	is mostly useful from within C<on_sel_grab> hooks.	1307	is mostly useful from within C<on_sel_grab> hooks.
1116		1308
1117	=item $oldtext = $term->selection ([$newtext])	1309	=item $oldtext = $term->selection ([$newtext, $clipboard])
1118		1310
1119	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.
1120		1317
1121	=item $term->overlay_simple ($x, $y, $text)	1318	=item $term->overlay_simple ($x, $y, $text)
1122		1319
1123	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.
1124		1321
…		…
1154		1351
1155	The methods currently supported on C<urxvt::overlay> objects are:	1352	The methods currently supported on C<urxvt::overlay> objects are:
1156		1353
1157	=over 4	1354	=over 4
1158		1355
1159	=item $overlay->set ($x, $y, $text, $rend)	1356	=item $overlay->set ($x, $y, $text[, $rend])
1160		1357
1161	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
1162	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
1163	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.
1164		1363
1165	=item $overlay->hide	1364	=item $overlay->hide
1166		1365
1167	If visible, hide the overlay, but do not destroy it.	1366	If visible, hide the overlay, but do not destroy it.
1168		1367
…		…
1238		1437
1239	Normally its not a good idea to use this function, as programs might be	1438	Normally its not a good idea to use this function, as programs might be
1240	confused by changes in cursor position or scrolling. Its useful inside a	1439	confused by changes in cursor position or scrolling. Its useful inside a
1241	C<on_add_lines> hook, though.	1440	C<on_add_lines> hook, though.
1242		1441
		1442	=item $term->scr_change_screen ($screen)
		1443
		1444	Switch to given screen - 0 primary, 1 secondary.
		1445
1243	=item $term->cmd_parse ($octets)	1446	=item $term->cmd_parse ($octets)
1244		1447
1245	Similar to C<scr_add_lines>, but the argument must be in the	1448	Similar to C<scr_add_lines>, but the argument must be in the
1246	locale-specific encoding of the terminal and can contain command sequences	1449	locale-specific encoding of the terminal and can contain command sequences
1247	(escape codes) that will be interpreted.	1450	(escape codes) that will be interpreted.
1248		1451
1249	=item $term->tt_write ($octets)	1452	=item $term->tt_write ($octets)
1250		1453
1251	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
1252	pass characters instead of octets, you should convert your strings first	1455	pass characters instead of octets, you should convert your strings first
1253	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.
1254		1463
1255	=item $old_events = $term->pty_ev_events ([$new_events])	1464	=item $old_events = $term->pty_ev_events ([$new_events])
1256		1465
1257	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
1258	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
1259	description of C<< urxvt::timer->events >>. Make sure to always restore	1468	description of C<< urxvt::timer->events >>. Make sure to always restore
1260	the previous value.	1469	the previous value.
1261		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
1262	=item $windowid = $term->parent	1476	=item $windowid = $term->parent
1263		1477
1264	Return the window id of the toplevel window.	1478	Return the window id of the toplevel window.
1265		1479
1266	=item $windowid = $term->vt	1480	=item $windowid = $term->vt
…		…
1272	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
1273	to receive pointer events all the times:	1487	to receive pointer events all the times:
1274		1488
1275	$term->vt_emask_add (urxvt::PointerMotionMask);	1489	$term->vt_emask_add (urxvt::PointerMotionMask);
1276		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
1277	=item $window_width = $term->width	1505	=item $window_width = $term->width
1278		1506
1279	=item $window_height = $term->height	1507	=item $window_height = $term->height
1280		1508
1281	=item $font_width = $term->fwidth	1509	=item $font_width = $term->fwidth
…		…
1311	=item $env = $term->env	1539	=item $env = $term->env
1312		1540
1313	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
1314	similar to C<\%ENV>.	1542	similar to C<\%ENV>.
1315		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
1316	=cut	1553	=cut
1317		1554
1318	sub env {	1555	sub env {
1319	if (my $env = $_[0]->_env) {
1320	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1556	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1321	} else {
1322	+{ %ENV }
1323	}
1324	}	1557	}
1325		1558
1326	=item $modifiermask = $term->ModLevel3Mask	1559	=item $modifiermask = $term->ModLevel3Mask
1327		1560
1328	=item $modifiermask = $term->ModMetaMask	1561	=item $modifiermask = $term->ModMetaMask
1329		1562
1330	=item $modifiermask = $term->ModNumLockMask	1563	=item $modifiermask = $term->ModNumLockMask
1331		1564
1332	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1565	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1333	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1566	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1567
		1568	=item $screen = $term->current_screen
		1569
		1570	Returns the currently displayed screen (0 primary, 1 secondary).
		1571
		1572	=item $cursor_is_hidden = $term->hidden_cursor
		1573
		1574	Returns whether the cursor is currently hidden or not.
1334		1575
1335	=item $view_start = $term->view_start ([$newvalue])	1576	=item $view_start = $term->view_start ([$newvalue])
1336		1577
1337	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
1338	C<0>, which displays the normal terminal contents. Lower values scroll	1579	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1346		1587
1347	Used after changing terminal contents to display them.	1588	Used after changing terminal contents to display them.
1348		1589
1349	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1590	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1350		1591
1351	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 >>
1352	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
1353	terminal line. The scrollback buffer starts at line C<-1> and extends to
1354	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1594	terminal line. Nothing will be returned if a nonexistent line
1355	is requested.	1595	is requested.
1356		1596
1357	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
1358	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
1359	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
1360	automatically be updated.	1600	automatically be updated.
1361		1601
1362	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
1363	than one cell when displayed are padded with urxvt::NOCHAR characters	1603	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1364	(C<chr 65535>). Characters with combining characters and other characters	1604	characters. Characters with combining characters and other characters that
1365	that do not fit into the normal tetx encoding will be replaced with	1605	do not fit into the normal text encoding will be replaced with characters
1366	characters in the private use area.	1606	in the private use area.
1367		1607
1368	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
1369	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
1370	characters.	1610	characters.
1371		1611
…		…
1455	}	1695	}
1456		1696
1457	sub urxvt::line::t {	1697	sub urxvt::line::t {
1458	my ($self) = @_;	1698	my ($self) = @_;
1459		1699
1460	if (@_ > 1)	1700	if (@_ > 1) {
1461	{
1462	$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})
1463	for $self->{beg} .. $self->{end};	1702	for $self->{beg} .. $self->{end};
1464	}	1703	}
1465		1704
1466	defined wantarray &&	1705	defined wantarray &&
1467	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1706	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1468	0, $self->{len}	1707	0, $self->{len}
1469	}	1708	}
1470		1709
1471	sub urxvt::line::r {	1710	sub urxvt::line::r {
1472	my ($self) = @_;	1711	my ($self) = @_;
1473		1712
1474	if (@_ > 1)	1713	if (@_ > 1) {
1475	{
1476	$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})
1477	for $self->{beg} .. $self->{end};	1715	for $self->{beg} .. $self->{end};
1478	}	1716	}
1479		1717
1480	if (defined wantarray) {	1718	if (defined wantarray) {
1481	my $rend = [	1719	my $rend = [
1482	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1720	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1483	];	1721	];
…		…
1515	where one character corresponds to one screen cell. See	1753	where one character corresponds to one screen cell. See
1516	C<< $term->ROW_t >> for details.	1754	C<< $term->ROW_t >> for details.
1517		1755
1518	=item $string = $term->special_decode $text	1756	=item $string = $term->special_decode $text
1519		1757
1520	Converts rxvt-unicodes text reprsentation into a perl string. See	1758	Converts rxvt-unicodes text representation into a perl string. See
1521	C<< $term->ROW_t >> for details.	1759	C<< $term->ROW_t >> for details.
1522		1760
1523	=item $success = $term->grab_button ($button, $modifiermask)	1761	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1524		1762
		1763	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1764
1525	Registers a synchronous button grab. See the XGrabButton manpage.	1765	Register/unregister a synchronous button grab. See the XGrabButton
		1766	manpage.
1526		1767
1527	=item $success = $term->grab ($eventtime[, $sync])	1768	=item $success = $term->grab ($eventtime[, $sync])
1528		1769
1529	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1770	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1530	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1771	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1531		1772
1532	=item $term->allow_events_async	1773	=item $term->allow_events_async
1533		1774
1534	Calls XAllowEvents with AsyncBoth for the most recent grab.	1775	Calls XAllowEvents with AsyncBoth for the most recent grab.
1535		1776
…		…
1542	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1783	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1543	recent grab.	1784	recent grab.
1544		1785
1545	=item $term->ungrab	1786	=item $term->ungrab
1546		1787
1547	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
1548	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
1549	the session.	1790	the session.
		1791
		1792	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1793
		1794	=item $atom_name = $term->XGetAtomName ($atom)
		1795
		1796	=item @atoms = $term->XListProperties ($window)
		1797
		1798	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1799
		1800	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1801
		1802	=item $term->XDeleteProperty ($window, $property)
		1803
		1804	=item $window = $term->DefaultRootWindow
		1805
		1806	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1807
		1808	=item $term->XMapWindow ($window)
		1809
		1810	=item $term->XUnmapWindow ($window)
		1811
		1812	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1813
		1814	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1815
		1816	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1817
		1818	=item $keysym = $term->XStringToKeysym ($string)
		1819
		1820	=item $string = $term->XKeysymToString ($keysym)
		1821
		1822	Various X or X-related functions. The C<$term> object only serves as
		1823	the source of the display, otherwise those functions map more-or-less
		1824	directly onto the X functions of the same name.
1550		1825
1551	=back	1826	=back
1552		1827
1553	=cut	1828	=cut
1554		1829
…		…
1618	my ($self, $text, $cb) = @_;	1893	my ($self, $text, $cb) = @_;
1619		1894
1620	$self->add_item ({ type => "button", text => $text, activate => $cb});	1895	$self->add_item ({ type => "button", text => $text, activate => $cb});
1621	}	1896	}
1622		1897
1623	=item $popup->add_toggle ($text, $cb, $initial_value)	1898	=item $popup->add_toggle ($text, $initial_value, $cb)
1624		1899
1625	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
1626	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
1627	argument.	1902	first argument.
1628		1903
1629	=cut	1904	=cut
1630		1905
1631	sub add_toggle {	1906	sub add_toggle {
1632	my ($self, $text, $cb, $value) = @_;	1907	my ($self, $text, $value, $cb) = @_;
1633		1908
1634	my $item; $item = {	1909	my $item; $item = {
1635	type => "button",	1910	type => "button",
1636	text => " $text",	1911	text => " $text",
1637	value => $value,	1912	value => $value,
…		…
1656	my $env = $self->{term}->env;	1931	my $env = $self->{term}->env;
1657	# 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.
1658	delete $env->{LC_ALL};	1933	delete $env->{LC_ALL};
1659	$env->{LC_CTYPE} = $self->{term}->locale;	1934	$env->{LC_CTYPE} = $self->{term}->locale;
1660		1935
1661	urxvt::term->new ($env, "popup",	1936	my $term = urxvt::term->new (
		1937	$env, "popup",
1662	"--perl-lib" => "", "--perl-ext-common" => "",	1938	"--perl-lib" => "", "--perl-ext-common" => "",
1663	"-pty-fd" => -1, "-sl" => 0,	1939	"-pty-fd" => -1, "-sl" => 0,
1664	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1940	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1665	"--transient-for" => $self->{term}->parent,	1941	"--transient-for" => $self->{term}->parent,
1666	"-display" => $self->{term}->display_id,	1942	"-display" => $self->{term}->display_id,
1667	"-pe" => "urxvt-popup")	1943	"-pe" => "urxvt-popup",
1668	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	}
1669	}	1951	}
1670		1952
1671	sub DESTROY {	1953	sub DESTROY {
1672	my ($self) = @_;	1954	my ($self) = @_;
1673		1955
…		…
1678	=back	1960	=back
1679		1961
1680	=cut	1962	=cut
1681		1963
1682	package urxvt::watcher;	1964	package urxvt::watcher;
1683
1684	@urxvt::timer::ISA = __PACKAGE__;
1685	@urxvt::iow::ISA = __PACKAGE__;
1686	@urxvt::pw::ISA = __PACKAGE__;
1687	@urxvt::iw::ISA = __PACKAGE__;
1688		1965
1689	=head2 The C<urxvt::timer> Class	1966	=head2 The C<urxvt::timer> Class
1690		1967
1691	This class implements timer watchers/events. Time is represented as a	1968	This class implements timer watchers/events. Time is represented as a
1692	fractional number of seconds since the epoch. Example:	1969	fractional number of seconds since the epoch. Example:
…		…
1696	->new	1973	->new
1697	->interval (1)	1974	->interval (1)
1698	->cb (sub {	1975	->cb (sub {
1699	$term->{overlay}->set (0, 0,	1976	$term->{overlay}->set (0, 0,
1700	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1977	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1701	});	1978	});
1702		1979
1703	=over 4	1980	=over 4
1704		1981
1705	=item $timer = new urxvt::timer	1982	=item $timer = new urxvt::timer
1706		1983
…		…
1709		1986
1710	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1987	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1711		1988
1712	Set the callback to be called when the timer triggers.	1989	Set the callback to be called when the timer triggers.
1713		1990
1714	=item $tstamp = $timer->at
1715
1716	Return the time this watcher will fire next.
1717
1718	=item $timer = $timer->set ($tstamp)	1991	=item $timer = $timer->set ($tstamp[, $interval])
1719		1992
1720	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).
1721		1995
1722	=item $timer = $timer->interval ($interval)	1996	=item $timer = $timer->interval ($interval)
1723		1997
1724	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
1725	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
1726	is automatically rescheduled at the given intervals.	2000	is automatically rescheduled at the given intervals.
1727		2001
1728	=item $timer = $timer->start	2002	=item $timer = $timer->start
1729		2003
1730	Start the timer.	2004	Start the timer.
1731		2005
1732	=item $timer = $timer->start ($tstamp)	2006	=item $timer = $timer->start ($tstamp[, $interval])
1733		2007
1734	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.
1735		2010
1736	=item $timer = $timer->after ($delay)	2011	=item $timer = $timer->after ($delay[, $interval])
1737		2012
1738	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>.
1739		2014
1740	=item $timer = $timer->stop	2015	=item $timer = $timer->stop
1741		2016
…		…
1749		2024
1750	$term->{socket} = ...	2025	$term->{socket} = ...
1751	$term->{iow} = urxvt::iow	2026	$term->{iow} = urxvt::iow
1752	->new	2027	->new
1753	->fd (fileno $term->{socket})	2028	->fd (fileno $term->{socket})
1754	->events (urxvt::EVENT_READ)	2029	->events (urxvt::EV_READ)
1755	->start	2030	->start
1756	->cb (sub {	2031	->cb (sub {
1757	my ($iow, $revents) = @_;	2032	my ($iow, $revents) = @_;
1758	# $revents must be 1 here, no need to check	2033	# $revents must be 1 here, no need to check
1759	sysread $term->{socket}, my $buf, 8192	2034	sysread $term->{socket}, my $buf, 8192
…		…
1772	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>
1773	is a bitset as described in the C<events> method.	2048	is a bitset as described in the C<events> method.
1774		2049
1775	=item $iow = $iow->fd ($fd)	2050	=item $iow = $iow->fd ($fd)
1776		2051
1777	Set the filedescriptor (not handle) to watch.	2052	Set the file descriptor (not handle) to watch.
1778		2053
1779	=item $iow = $iow->events ($eventmask)	2054	=item $iow = $iow->events ($eventmask)
1780		2055
1781	Set the event mask to watch. The only allowed values are	2056	Set the event mask to watch. The only allowed values are
1782	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
1783	together, or C<urxvt::EVENT_NONE>.	2058	together, or C<urxvt::EV_NONE>.
1784		2059
1785	=item $iow = $iow->start	2060	=item $iow = $iow->start
1786		2061
1787	Start watching for requested events on the given handle.	2062	Start watching for requested events on the given handle.
1788		2063
1789	=item $iow = $iow->stop	2064	=item $iow = $iow->stop
1790		2065
1791	Stop watching for events on the given filehandle.	2066	Stop watching for events on the given file handle.
		2067
		2068	=back
		2069
		2070	=head2 The C<urxvt::iw> Class
		2071
		2072	This class implements idle watchers, that get called automatically when
		2073	the process is idle. They should return as fast as possible, after doing
		2074	some useful work.
		2075
		2076	=over 4
		2077
		2078	=item $iw = new urxvt::iw
		2079
		2080	Create a new idle watcher object in stopped state.
		2081
		2082	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2083
		2084	Set the callback to be called when the watcher triggers.
		2085
		2086	=item $timer = $timer->start
		2087
		2088	Start the watcher.
		2089
		2090	=item $timer = $timer->stop
		2091
		2092	Stop the watcher.
		2093
		2094	=back
		2095
		2096	=head2 The C<urxvt::pw> Class
		2097
		2098	This class implements process watchers. They create an event whenever a
		2099	process exits, after which they stop automatically.
		2100
		2101	my $pid = fork;
		2102	...
		2103	$term->{pw} = urxvt::pw
		2104	->new
		2105	->start ($pid)
		2106	->cb (sub {
		2107	my ($pw, $exit_status) = @_;
		2108	...
		2109	});
		2110
		2111	=over 4
		2112
		2113	=item $pw = new urxvt::pw
		2114
		2115	Create a new process watcher in stopped state.
		2116
		2117	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2118
		2119	Set the callback to be called when the timer triggers.
		2120
		2121	=item $pw = $timer->start ($pid)
		2122
		2123	Tells the watcher to start watching for process C<$pid>.
		2124
		2125	=item $pw = $pw->stop
		2126
		2127	Stop the watcher.
1792		2128
1793	=back	2129	=back
1794		2130
1795	=head1 ENVIRONMENT	2131	=head1 ENVIRONMENT
1796		2132
…		…
1805		2141
1806	=item >= 3 - script loading and management	2142	=item >= 3 - script loading and management
1807		2143
1808	=item >=10 - all called hooks	2144	=item >=10 - all called hooks
1809		2145
1810	=item >=11 - hook reutrn values	2146	=item >=11 - hook return values
1811		2147
1812	=back	2148	=back
1813		2149
1814	=head1 AUTHOR	2150	=head1 AUTHOR
1815		2151
1816	Marc Lehmann <pcg@goof.com>	2152	Marc Lehmann <schmorp@schmorp.de>
1817	http://software.schmorp.de/pkg/rxvt-unicode	2153	http://software.schmorp.de/pkg/rxvt-unicode
1818		2154
1819	=cut	2155	=cut
1820		2156
1821	1	2157	1
		2158
		2159	# vim: sw=3:

Diff Legend

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