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.128 by root, Wed Jan 25 00:57:57 2006 UTC vs.
Revision 1.231 by root, Sun Apr 27 20:26:28 2014 UTC

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

Diff Legend

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