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.127 by root, Wed Jan 25 00:42:21 2006 UTC vs.
Revision 1.223 by root, Sat Jul 14 08:00:18 2012 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --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 @@RXVT_NAME@@d, 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<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed
		38	using 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	@@RXVT_NAME@@ -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 automove-background
218
219	This is basically a one-line extension that dynamically changes the background pixmap offset
220	to the window position, in effect creating the same effect as pseudo transparency with
221	a custom pixmap. No scaling is supported in this mode. Exmaple:
222
223	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
224
225	=item block-graphics-to-ascii
226
227	A not very useful example of filtering all text output to the terminal,
228	by replacing all line-drawing characters (U+2500 .. U+259F) by a
229	similar-looking ascii character.
230
231	=item digital-clock
232
233	Displays a digital clock using the built-in overlay.
234
235	=item example-refresh-hooks
236
237	Displays a very simple digital clock in the upper right corner of the
238	window. Illustrates overwriting the refresh callbacks to create your own
239	overlays or changes.
240
241	=item selection-pastebin
242
243	This is a little rarely useful extension that Uploads the selection as
244	textfile to a remote site (or does other things). (The implementation is
245	not currently secure for use in a multiuser environment as it writes to
246	F</tmp> directly.).
247
248	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
249	i.e.
250
251	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
252
253	Pressing this combination runs a command with C<%> replaced by the name of
254	the textfile. This command can be set via a resource:
255
256	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
257
258	And the default is likely not useful to anybody but the few people around
259	here :)
260
261	The name of the textfile is the hex encoded md5 sum of the selection, so
262	the same content should lead to the same filename.
263
264	After a successful upload the selection will be replaced by the text given
265	in the C<selection-pastebin-url> resource (again, the % is the placeholder
266	for the filename):
267
268	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
269
270	=back
271		50
272	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
273		52
274	=head2 General API Considerations	53	=head2 General API Considerations
275		54
…		…
289		68
290	=over 4	69	=over 4
291		70
292	=item $text	71	=item $text
293		72
294	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
295	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.
296		75
297	=item $string	76	=item $string
298		77
299	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
…		…
303	=item $octets	82	=item $octets
304		83
305	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
306	locale-specific way.	85	locale-specific way.
307		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
308	=back	93	=back
309		94
310	=head2 Extension Objects	95	=head2 Extension Objects
311		96
312	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
313	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,
314	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
315	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
316	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
317	use.	103	internal use.
318		104
319	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
320	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
321		107
322	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
323		109	the C<urxvt::extension> section below.
324	=over 4
325
326	=item $urxvt_term = $self->{term}
327
328	Returns the C<urxvt::term> object associated with this instance of the
329	extension. This member I<must not> be changed in any way.
330
331	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
332
333	Dynamically enable the given hooks (named without the C<on_> prefix) for
334	this extension, replacing any previous hook. This is useful when you want
335	to overwrite time-critical hooks only temporarily.
336
337	=item $self->disable ($hook_name[, $hook_name..])
338
339	Dynamically disable the given hooks.
340
341	=back
342		110
343	=head2 Hooks	111	=head2 Hooks
344		112
345	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
346	called whenever the relevant event happens.	114	called whenever the relevant event happens.
347		115
348	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
349	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
350		118
351	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
352	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
353	relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
…		…
366	place.	134	place.
367		135
368	=item on_start $term	136	=item on_start $term
369		137
370	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
371	trying to map (display) the toplevel and returning to the mainloop.	139	trying to map (display) the toplevel and returning to the main loop.
372		140
373	=item on_destroy $term	141	=item on_destroy $term
374		142
375	Called whenever something tries to destroy terminal, when the terminal is	143	Called whenever something tries to destroy terminal, when the terminal is
376	still fully functional (not for long, though).	144	still fully functional (not for long, though).
…		…
403		171
404	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
405	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
406	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
407		175
408	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.
409		177
410	=item on_sel_extend $term	178	=item on_sel_extend $term
411		179
412	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
413	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
414	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
415	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
416	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
417	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
418		186
419	See the F<selection> example extension.	187	See the F<selection> example extension.
420		188
421	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
422		190
423	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
424	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
425	show this many lines of scrollback.	193	show this many lines of scrollback.
426		194
427	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
428		196
…		…
432		200
433	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,
434	$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
435	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
436		204
437	=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
438		216
439	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
440	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
441	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
442	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,
443	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
444	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	}
445		233
446	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,
447	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
448	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.
449		240
450	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
451		242
452	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
453	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
…		…
458	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
459		250
460	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
461	suppress or filter tty input.	252	suppress or filter tty input.
462		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
463	=item on_line_update $term, $row	261	=item on_line_update $term, $row
464		262
465	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
466	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
467	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,
…		…
474	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
475	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
476		274
477	=item on_refresh_begin $term	275	=item on_refresh_begin $term
478		276
479	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
480	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
481	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
482	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
483		281
484	=item on_refresh_end $term	282	=item on_refresh_end $term
485		283
486	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>.
487		285
488	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string
489		287
490	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
491	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>
492	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the @@RXVT_NAME@@(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.
493		307
494	=item on_x_event $term, $event	308	=item on_x_event $term, $event
495		309
496	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
497	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
498	members are not passed.	312	members are not passed.
499		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
500	=item on_focus_in $term	318	=item on_focus_in $term
501		319
502	Called whenever the window gets the keyboard focus, before rxvt-unicode	320	Called whenever the window gets the keyboard focus, before rxvt-unicode
503	does focus in processing.	321	does focus in processing.
504		322
505	=item on_focus_out $term	323	=item on_focus_out $term
506		324
507	Called wheneever the window loses keyboard focus, before rxvt-unicode does	325	Called whenever the window loses keyboard focus, before rxvt-unicode does
508	focus out processing.	326	focus out processing.
509		327
510	=item on_configure_notify $term, $event	328	=item on_configure_notify $term, $event
511		329
512	=item on_property_notify $term, $event	330	=item on_property_notify $term, $event
…		…
523		341
524	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
525		343
526	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
527		345
528	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
529	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.
530		348
531	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
532	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
533	(real, not screen-based) row and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
534		352
…		…
544	=item on_wm_delete_window $term, $event	362	=item on_wm_delete_window $term, $event
545		363
546	Called when various types of ClientMessage events are received (all with	364	Called when various types of ClientMessage events are received (all with
547	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
548		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
549	=back	371	=back
550		372
551	=cut	373	=cut
552		374
553	package urxvt;	375	package urxvt;
554		376
555	use utf8;	377	use utf8;
556	use strict;	378	use strict 'vars';
557	use Carp ();	379	use Carp ();
558	use Scalar::Util ();	380	use Scalar::Util ();
559	use List::Util ();	381	use List::Util ();
560		382
561	our $VERSION = 1;	383	our $VERSION = 1;
562	our $TERM;	384	our $TERM;
563	our @TERM_INIT;	385	our @TERM_INIT; # should go, prevents async I/O etc.
564	our @TERM_EXT;	386	our @TERM_EXT; # should go, prevents async I/O etc.
565	our @HOOKNAME;	387	our @HOOKNAME;
566	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
567	our %OPTION;	389	our %OPTION;
568		390
569	our $LIBDIR;	391	our $LIBDIR;
…		…
595	The current terminal. This variable stores the current C<urxvt::term>	417	The current terminal. This variable stores the current C<urxvt::term>
596	object, whenever a callback/hook is executing.	418	object, whenever a callback/hook is executing.
597		419
598	=item @urxvt::TERM_INIT	420	=item @urxvt::TERM_INIT
599		421
600	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
601	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
602	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,
603	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.
604		426
605	This complements to the perl-eval commandline option, but gets executed	427	This complements to the perl-eval command line option, but gets executed
606	first.	428	first.
607		429
608	=item @urxvt::TERM_EXT	430	=item @urxvt::TERM_EXT
609		431
610	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
…		…
617		439
618	=over 4	440	=over 4
619		441
620	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
621		443
622	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
623	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
624	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
625		448
626	=item urxvt::warn $string	449	=item urxvt::warn $string
627		450
628	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
629	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
630	that calls this function.	453	that calls this function.
631		454
632	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
633	correct place, e.g. on stderr of the connecting urxvtc client.	456	correct place, e.g. on stderr of the connecting urxvtc client.
634		457
635	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).
636		466
637	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
638		468
639	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
640		470
…		…
683		513
684	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
685		515
686	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
687		517
688	=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
689		520
690	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
691	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
692	the bitset.	523	the bitset.
693		524
…		…
698	Return the foreground/background colour index, respectively.	529	Return the foreground/background colour index, respectively.
699		530
700	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	531	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
701		532
702	=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
703		536
704	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
705	specified one.	538	specified one.
706		539
707	=item $value = urxvt::GET_CUSTOM $rend	540	=item $value = urxvt::GET_CUSTOM $rend
…		…
728	};	561	};
729	}	562	}
730		563
731	no warnings 'utf8';	564	no warnings 'utf8';
732		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
733	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
734		627
735	sub verbose {	628	sub verbose {
736	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
737	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
…		…
749	$pkg =~ s/[^[:word:]]/_/g;	642	$pkg =~ s/[^[:word:]]/_/g;
750	$pkg = "urxvt::ext::$pkg";	643	$pkg = "urxvt::ext::$pkg";
751		644
752	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
753		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		648
754	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
755	or die "$path: $!";	650	or die "$path: $!";
756		651
757	my $source =	652	my $source =
758	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
759	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
760	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
761	. "\n};\n1";	656	. "\n};\n1";
762		657
763	eval $source	658	eval $source
…		…
773	sub invoke {	668	sub invoke {
774	local $TERM = shift;	669	local $TERM = shift;
775	my $htype = shift;	670	my $htype = shift;
776		671
777	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
778	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
779		674
780	my %ext_arg;	675	my %ext_arg;
781		676
782	{	677	{
783	my @init = @TERM_INIT;	678	my @init = @TERM_INIT;
784	@TERM_INIT = ();	679	@TERM_INIT = ();
…		…
786	my @pkg = @TERM_EXT;	681	my @pkg = @TERM_EXT;
787	@TERM_EXT = ();	682	@TERM_EXT = ();
788	$TERM->register_package ($_) for @pkg;	683	$TERM->register_package ($_) for @pkg;
789	}	684	}
790		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
791	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
792	if ($_ eq "default") {	690	if ($_ eq "default") {
793	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	691	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
794	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
795	delete $ext_arg{$1};	693	delete $ext_arg{$1};
796	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
…		…
798	} else {	696	} else {
799	$ext_arg{$_} ||= [];	697	$ext_arg{$_} ||= [];
800	}	698	}
801	}	699	}
802		700
803	while (my ($ext, $argv) = each %ext_arg) {	701	for my $ext (sort keys %ext_arg) {
804	my @files = grep -f $_, map "$_/$ext", @dirs;	702	my @files = grep -f $_, map "$_/$ext", @dirs;
805		703
806	if (@files) {	704	if (@files) {
807	$TERM->register_package (extension_package $files[0], $argv);	705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
808	} else {	706	} else {
809	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";
810	}	708	}
811	}	709	}
812		710
…		…
818		716
819	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
820	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
821	if $verbosity >= 10;	719	if $verbosity >= 10;
822		720
823	keys %$cb;	721	for my $pkg (keys %$cb) {
824
825	while (my ($pkg, $cb) = each %$cb) {
826	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
827	$retval ||= $retval_;	723	$retval ||= $retval_;
828		724
829	if ($@) {	725	if ($@) {
830	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
831	warn $@;	727	warn $@;
…		…
845	}	741	}
846		742
847	$retval	743	$retval
848	}	744	}
849		745
850	# 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	}
851		774
852	package urxvt::term::extension;	775	package urxvt::term::extension;
853		776
854	sub enable {	777	=head2 The C<urxvt::term::extension> class
855	my ($self, %hook) = @_;
856	my $pkg = $self->{_pkg};
857		778
858	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
859	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
860	defined $htype
861	or Carp::croak "unsupported hook type '$name'";
862		781
863	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
864	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
865		784
866	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
867	}	786	objects, in addition to call methods documented for the <urxvt::term>
868	}	787	class.
869		788
870	sub disable {	789	=over 4
871	my ($self, @hook) = @_;
872	my $pkg = $self->{_pkg};
873		790
874	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
875	my $htype = $HOOKTYPE{uc $name};
876	defined $htype
877	or Carp::croak "unsupported hook type '$name'";
878		792
879	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
880	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
881	}	795
882	}	796	=cut
883		797
884	our $AUTOLOAD;	798	our $AUTOLOAD;
885		799
886	sub AUTOLOAD {	800	sub AUTOLOAD {
887	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
900		814
901	sub DESTROY {	815	sub DESTROY {
902	# nop	816	# nop
903	}	817	}
904		818
905	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
906		820
907	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
908	${$_[0]}->();	822	${$_[0]}->();
909	}	823	}
910		824
911	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
912	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
913	}	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	warn "disable hook $htype,$id\n";#d#
		890	delete $term->{_hook}[$htype]{$id};
		891	$term->set_should_invoke ($htype, -1);
		892	}
		893	}
		894
		895	sub on {
		896	my ($self, %hook) = @_;
		897
		898	my $term = $self->{term};
		899
		900	my %disable = ( "" => $term );
		901
		902	while (my ($name, $cb) = each %hook) {
		903	my $htype = $HOOKTYPE{uc $name};
		904	defined $htype
		905	or Carp::croak "unsupported hook type '$name'";
		906
		907	$term->set_should_invoke ($htype, +1);
		908	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		909	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		910	}
		911
		912	bless \%disable, "urxvt::extension::on_disable"
		913	}
		914
		915	=item $self->x_resource ($pattern)
		916
		917	=item $self->x_resource_boolean ($pattern)
		918
		919	These methods support an additional C<%> prefix when called on an
		920	extension object - see the description of these methods in the
		921	C<urxvt::term> class for details.
		922
		923	=cut
		924
		925	sub x_resource {
		926	my ($self, $name) = @_;
		927	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		928	$self->{term}->x_resource ($name)
		929	}
		930
		931	sub x_resource_boolean {
		932	my ($self, $name) = @_;
		933	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		934	$self->{term}->x_resource_boolean ($name)
		935	}
		936
		937	=back
		938
		939	=cut
914		940
915	package urxvt::anyevent;	941	package urxvt::anyevent;
916		942
917	=head2 The C<urxvt::anyevent> Class	943	=head2 The C<urxvt::anyevent> Class
918		944
919	The sole purpose of this class is to deliver an interface to the	945	The sole purpose of this class is to deliver an interface to the
920	C<AnyEvent> module - any module using it will work inside urxvt without	946	C<AnyEvent> module - any module using it will work inside urxvt without
921	further programming. The only exception is that you cannot wait on	947	further programming. The only exception is that you cannot wait on
922	condition variables, but non-blocking condvar use is ok. What this means	948	condition variables, but non-blocking condvar use is ok.
923	is that you cannot use blocking APIs, but the non-blocking variant should
924	work.
925		949
926	=cut	950	In practical terms this means is that you cannot use blocking APIs, but
		951	the non-blocking variant should work.
927		952
		953	=cut
		954
928	our $VERSION = 1;	955	our $VERSION = '5.23';
929		956
930	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	957	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
931	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	958	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
932		959
933	sub timer {	960	sub timer {
…		…
935		962
936	my $cb = $arg{cb};	963	my $cb = $arg{cb};
937		964
938	urxvt::timer	965	urxvt::timer
939	->new	966	->new
940	->start (urxvt::NOW + $arg{after})	967	->after ($arg{after}, $arg{interval})
941	->cb (sub {	968	->cb ($arg{interval} ? $cb : sub {
942	$_[0]->stop; # need to cancel manually	969	$_[0]->stop; # need to cancel manually
943	$cb->();	970	$cb->();
944	})	971	})
945	}	972	}
946		973
947	sub io {	974	sub io {
948	my ($class, %arg) = @_;	975	my ($class, %arg) = @_;
949		976
950	my $cb = $arg{cb};	977	my $cb = $arg{cb};
		978	my $fd = fileno $arg{fh};
		979	defined $fd or $fd = $arg{fh};
951		980
952	bless [$arg{fh}, urxvt::iow	981	bless [$arg{fh}, urxvt::iow
953	->new	982	->new
954	->fd (fileno $arg{fh})	983	->fd ($fd)
955	->events (($arg{poll} =~ /r/ ? 1 : 0)	984	->events (($arg{poll} =~ /r/ ? 1 : 0)
956	| ($arg{poll} =~ /w/ ? 2 : 0))	985	| ($arg{poll} =~ /w/ ? 2 : 0))
957	->start	986	->start
958	->cb (sub {	987	->cb ($cb)
959	$cb->(($_[1] & 1 ? 'r' : '')
960	. ($_[1] & 2 ? 'w' : ''));
961	})],
962	urxvt::anyevent::	988	], urxvt::anyevent::
		989	}
		990
		991	sub idle {
		992	my ($class, %arg) = @_;
		993
		994	my $cb = $arg{cb};
		995
		996	urxvt::iw
		997	->new
		998	->start
		999	->cb ($cb)
		1000	}
		1001
		1002	sub child {
		1003	my ($class, %arg) = @_;
		1004
		1005	my $cb = $arg{cb};
		1006
		1007	urxvt::pw
		1008	->new
		1009	->start ($arg{pid})
		1010	->cb (sub {
		1011	$_[0]->stop; # need to cancel manually
		1012	$cb->($_[0]->rpid, $_[0]->rstatus);
		1013	})
963	}	1014	}
964		1015
965	sub DESTROY {	1016	sub DESTROY {
966	$_[0][1]->stop;	1017	$_[0][1]->stop;
967	}	1018	}
968		1019
969	sub condvar {	1020	# only needed for AnyEvent < 6 compatibility
970	bless \my $flag, urxvt::anyevent::condvar::	1021	sub one_event {
971	}
972
973	sub urxvt::anyevent::condvar::broadcast {
974	${$_[0]}++;
975	}
976
977	sub urxvt::anyevent::condvar::wait {
978	unless (${$_[0]}) {
979	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1022	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
980	}
981	}	1023	}
982		1024
983	package urxvt::term;	1025	package urxvt::term;
984		1026
985	=head2 The C<urxvt::term> Class	1027	=head2 The C<urxvt::term> Class
…		…
998	urxvt::verbose 6, "register package $pkg to $self";	1040	urxvt::verbose 6, "register package $pkg to $self";
999		1041
1000	@{"$pkg\::ISA"} = urxvt::term::extension::;	1042	@{"$pkg\::ISA"} = urxvt::term::extension::;
1001		1043
1002	my $proxy = bless {	1044	my $proxy = bless {
1003	_pkg => $pkg,	1045	_pkg => $pkg,
		1046	_name => ${"$pkg\::_NAME"}, # hackish
1004	argv => $argv,	1047	argv => $argv,
1005	}, $pkg;	1048	}, $pkg;
1006	Scalar::Util::weaken ($proxy->{term} = $self);	1049	Scalar::Util::weaken ($proxy->{term} = $self);
1007		1050
1008	$self->{_pkg}{$pkg} = $proxy;	1051	$self->{_pkg}{$pkg} = $proxy;
1009		1052
…		…
1012	$proxy->enable ($name => $ref);	1055	$proxy->enable ($name => $ref);
1013	}	1056	}
1014	}	1057	}
1015	}	1058	}
1016		1059
		1060	sub perl_libdirs {
		1061	map { split /:/ }
		1062	$_[0]->resource ("perl_lib"),
		1063	$ENV{URXVT_PERL_LIB},
		1064	"$ENV{HOME}/.urxvt/ext",
		1065	"$LIBDIR/perl"
		1066	}
		1067
		1068	sub scan_meta {
		1069	my ($self) = @_;
		1070	my @libdirs = perl_libdirs $self;
		1071
		1072	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1073
		1074	my %meta;
		1075
		1076	$self->{meta_libdirs} = join "\x00", @libdirs;
		1077	$self->{meta} = \%meta;
		1078
		1079	for my $dir (reverse @libdirs) {
		1080	opendir my $fh, $dir
		1081	or next;
		1082	for my $ext (readdir $fh) {
		1083	$ext ne "."
		1084	and $ext ne ".."
		1085	and open my $fh, "<", "$dir/$ext"
		1086	or next;
		1087
		1088	while (<$fh>) {
		1089	if (/^#:META:X_RESOURCE:(.*)/) {
		1090	my ($pattern, $type, $desc) = split /:/, $1;
		1091	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1092	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1093	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1094	} else {
		1095	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1096	}
		1097	} elsif (/^\s*(?:#|$)/) {
		1098	# skip other comments and empty lines
		1099	} else {
		1100	last; # stop parsing on first non-empty non-comment line
		1101	}
		1102	}
		1103	}
		1104	}
		1105	}
		1106
1017	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1107	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1018		1108
1019	Creates a new terminal, very similar as if you had started it with system	1109	Creates a new terminal, very similar as if you had started it with system
1020	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1110	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1021	hash which defines the environment of the new terminal.	1111	hash which defines the environment of the new terminal.
1022		1112
1023	Croaks (and probably outputs an error message) if the new instance	1113	Croaks (and probably outputs an error message) if the new instance
1024	couldn't be created. Returns C<undef> if the new instance didn't	1114	couldn't be created. Returns C<undef> if the new instance didn't
1025	initialise perl, and the terminal object otherwise. The C<init> and	1115	initialise perl, and the terminal object otherwise. The C<init> and
1026	C<start> hooks will be called during this call.	1116	C<start> hooks will be called before this call returns, and are free to
		1117	refer to global data (which is race free).
1027		1118
1028	=cut	1119	=cut
1029		1120
1030	sub new {	1121	sub new {
1031	my ($class, $env, @args) = @_;	1122	my ($class, $env, @args) = @_;
1032		1123
		1124	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1125	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1126
1033	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1127	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1034	}	1128	}
1035		1129
1036	=item $term->destroy	1130	=item $term->destroy
1037		1131
1038	Destroy the terminal object (close the window, free resources	1132	Destroy the terminal object (close the window, free resources
…		…
1068		1162
1069	Returns true if the option specified by C<$optval> is enabled, and	1163	Returns true if the option specified by C<$optval> is enabled, and
1070	optionally change it. All option values are stored by name in the hash	1164	optionally change it. All option values are stored by name in the hash
1071	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1165	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1072		1166
1073	Here is a a likely non-exhaustive list of option names, please see the	1167	Here is a likely non-exhaustive list of option names, please see the
1074	source file F</src/optinc.h> to see the actual list:	1168	source file F</src/optinc.h> to see the actual list:
1075		1169
1076	borderLess console cursorBlink cursorUnderline hold iconic insecure	1170	borderLess buffered console cursorBlink cursorUnderline hold iconic
1077	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1171	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1078	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1172	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1079	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1173	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1080	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1174	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1081	transparent tripleclickwords utmpInhibit visualBell	1175	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1176	urgentOnBell utmpInhibit visualBell
1082		1177
1083	=item $value = $term->resource ($name[, $newval])	1178	=item $value = $term->resource ($name[, $newval])
1084		1179
1085	Returns the current resource value associated with a given name and	1180	Returns the current resource value associated with a given name and
1086	optionally sets a new value. Setting values is most useful in the C<init>	1181	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1095	likely change).	1190	likely change).
1096		1191
1097	Please note that resource strings will currently only be freed when the	1192	Please note that resource strings will currently only be freed when the
1098	terminal is destroyed, so changing options frequently will eat memory.	1193	terminal is destroyed, so changing options frequently will eat memory.
1099		1194
1100	Here is a a likely non-exhaustive list of resource names, not all of which	1195	Here is a likely non-exhaustive list of resource names, not all of which
1101	are supported in every build, please see the source file F</src/rsinc.h>	1196	are supported in every build, please see the source file F</src/rsinc.h>
1102	to see the actual list:	1197	to see the actual list:
1103		1198
1104	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1199	answerbackstring backgroundPixmap backspace_key blurradius
1105	borderLess color cursorBlink cursorUnderline cutchars delete_key	1200	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1106	display_name embed ext_bwidth fade font geometry hold iconName	1201	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1107	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1202	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1203	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1108	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1204	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1109	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1205	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1110	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1206	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1111	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1207	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1112	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1208	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1113	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1209	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1114	secondaryScreen secondaryScroll selectstyle shade term_name title	1210	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1115	transient_for transparent transparent_all tripleclickwords utmpInhibit	1211	term_name title transient_for transparent tripleclickwords urgentOnBell
1116	visualBell	1212	utmpInhibit visualBell
1117		1213
1118	=cut	1214	=cut
1119		1215
1120	sub resource($$;$) {	1216	sub resource($$;$) {
1121	my ($self, $name) = (shift, shift);	1217	my ($self, $name) = (shift, shift);
1122	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1218	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1123	&urxvt::term::_resource	1219	goto &urxvt::term::_resource
1124	}	1220	}
1125		1221
1126	=item $value = $term->x_resource ($pattern)	1222	=item $value = $term->x_resource ($pattern)
1127		1223
1128	Returns the X-Resource for the given pattern, excluding the program or	1224	Returns the X-Resource for the given pattern, excluding the program or
1129	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1225	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1130	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1226	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1131	resource with that pattern exists.	1227	resource with that pattern exists.
1132		1228
		1229	Extensions that define extra resource or command line arguments also need
		1230	to call this method to access their values.
		1231
		1232	If the method is called on an extension object (basically, from an
		1233	extension), then the special prefix C<%.> will be replaced by the name of
		1234	the extension and a dot, and the lone string C<%> will be replaced by the
		1235	extension name itself. This makes it possible to code extensions so you
		1236	can rename them and get a new set of commandline switches and resources
		1237	without having to change the actual code.
		1238
1133	This method should only be called during the C<on_start> hook, as there is	1239	This method should only be called during the C<on_start> hook, as there is
1134	only one resource database per display, and later invocations might return	1240	only one resource database per display, and later invocations might return
1135	the wrong resources.	1241	the wrong resources.
1136		1242
1137	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1243	=item $value = $term->x_resource_boolean ($pattern)
1138		1244
		1245	Like C<x_resource>, above, but interprets the string value as a boolean
		1246	and returns C<1> for true values, C<0> for false values and C<undef> if
		1247	the resource or option isn't specified.
		1248
		1249	You should always use this method to parse boolean resources.
		1250
		1251	=cut
		1252
		1253	sub x_resource_boolean {
		1254	my $res = &x_resource;
		1255
		1256	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1257	}
		1258
		1259	=item $success = $term->parse_keysym ($key, $octets)
		1260
1139	Adds a keymap translation exactly as specified via a resource. See the	1261	Adds a key binding exactly as specified via a resource. See the
1140	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1262	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1263
		1264	=item $term->register_command ($keysym, $modifiermask, $string)
		1265
		1266	Adds a key binding. This is a lower level api compared to
		1267	C<parse_keysym>, as it expects a parsed key description, and can be
		1268	used only inside either the C<on_init> hook, to add a binding, or the
		1269	C<on_register_command> hook, to modify a parsed binding.
1141		1270
1142	=item $rend = $term->rstyle ([$new_rstyle])	1271	=item $rend = $term->rstyle ([$new_rstyle])
1143		1272
1144	Return and optionally change the current rendition. Text that is output by	1273	Return and optionally change the current rendition. Text that is output by
1145	the terminal application will use this style.	1274	the terminal application will use this style.
…		…
1153		1282
1154	=item ($row, $col) = $term->selection_beg ([$row, $col])	1283	=item ($row, $col) = $term->selection_beg ([$row, $col])
1155		1284
1156	=item ($row, $col) = $term->selection_end ([$row, $col])	1285	=item ($row, $col) = $term->selection_end ([$row, $col])
1157		1286
1158	Return the current values of the selection mark, begin or end positions,	1287	Return the current values of the selection mark, begin or end positions.
1159	and optionally set them to new values.	1288
		1289	When arguments are given, then the selection coordinates are set to
		1290	C<$row> and C<$col>, and the selection screen is set to the current
		1291	screen.
		1292
		1293	=item $screen = $term->selection_screen ([$screen])
		1294
		1295	Returns the current selection screen, and then optionally sets it.
1160		1296
1161	=item $term->selection_make ($eventtime[, $rectangular])	1297	=item $term->selection_make ($eventtime[, $rectangular])
1162		1298
1163	Tries to make a selection as set by C<selection_beg> and	1299	Tries to make a selection as set by C<selection_beg> and
1164	C<selection_end>. If C<$rectangular> is true (default: false), a	1300	C<selection_end>. If C<$rectangular> is true (default: false), a
1165	rectangular selection will be made. This is the prefered function to make	1301	rectangular selection will be made. This is the preferred function to make
1166	a selection.	1302	a selection.
1167		1303
1168	=item $success = $term->selection_grab ($eventtime)	1304	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1169		1305
1170	Try to request the primary selection text from the server (for example, as	1306	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1307	true) selection from the server. The corresponding text can be set
1171	set by the next method). No visual feedback will be given. This function	1308	with the next method. No visual feedback will be given. This function
1172	is mostly useful from within C<on_sel_grab> hooks.	1309	is mostly useful from within C<on_sel_grab> hooks.
1173		1310
1174	=item $oldtext = $term->selection ([$newtext])	1311	=item $oldtext = $term->selection ([$newtext, $clipboard])
1175		1312
1176	Return the current selection text and optionally replace it by C<$newtext>.	1313	Return the current selection (clipboard if C<$clipboard> is true) text
		1314	and optionally replace it by C<$newtext>.
		1315
		1316	=item $term->selection_clear ([$clipboard])
		1317
		1318	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1177		1319
1178	=item $term->overlay_simple ($x, $y, $text)	1320	=item $term->overlay_simple ($x, $y, $text)
1179		1321
1180	Create a simple multi-line overlay box. See the next method for details.	1322	Create a simple multi-line overlay box. See the next method for details.
1181		1323
…		…
1211		1353
1212	The methods currently supported on C<urxvt::overlay> objects are:	1354	The methods currently supported on C<urxvt::overlay> objects are:
1213		1355
1214	=over 4	1356	=over 4
1215		1357
1216	=item $overlay->set ($x, $y, $text, $rend)	1358	=item $overlay->set ($x, $y, $text[, $rend])
1217		1359
1218	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1360	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1219	text in rxvt-unicode's special encoding and an array of rendition values	1361	text in rxvt-unicode's special encoding and an array of rendition values
1220	at a specific position inside the overlay.	1362	at a specific position inside the overlay.
		1363
		1364	If C<$rend> is missing, then the rendition will not be changed.
1221		1365
1222	=item $overlay->hide	1366	=item $overlay->hide
1223		1367
1224	If visible, hide the overlay, but do not destroy it.	1368	If visible, hide the overlay, but do not destroy it.
1225		1369
…		…
1307	locale-specific encoding of the terminal and can contain command sequences	1451	locale-specific encoding of the terminal and can contain command sequences
1308	(escape codes) that will be interpreted.	1452	(escape codes) that will be interpreted.
1309		1453
1310	=item $term->tt_write ($octets)	1454	=item $term->tt_write ($octets)
1311		1455
1312	Write the octets given in C<$data> to the tty (i.e. as program input). To	1456	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1313	pass characters instead of octets, you should convert your strings first	1457	pass characters instead of octets, you should convert your strings first
1314	to the locale-specific encoding using C<< $term->locale_encode >>.	1458	to the locale-specific encoding using C<< $term->locale_encode >>.
		1459
		1460	=item $term->tt_paste ($octets)
		1461
		1462	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1463	CR and bracketing the data with control sequences if bracketed paste mode
		1464	is set.
1315		1465
1316	=item $old_events = $term->pty_ev_events ([$new_events])	1466	=item $old_events = $term->pty_ev_events ([$new_events])
1317		1467
1318	Replaces the event mask of the pty watcher by the given event mask. Can	1468	Replaces the event mask of the pty watcher by the given event mask. Can
1319	be used to suppress input and output handling to the pty/tty. See the	1469	be used to suppress input and output handling to the pty/tty. See the
…		…
1338	Adds the specified events to the vt event mask. Useful e.g. when you want	1488	Adds the specified events to the vt event mask. Useful e.g. when you want
1339	to receive pointer events all the times:	1489	to receive pointer events all the times:
1340		1490
1341	$term->vt_emask_add (urxvt::PointerMotionMask);	1491	$term->vt_emask_add (urxvt::PointerMotionMask);
1342		1492
		1493	=item $term->set_urgency ($set)
		1494
		1495	Enable/disable the urgency hint on the toplevel window.
		1496
		1497	=item $term->focus_in
		1498
		1499	=item $term->focus_out
		1500
		1501	=item $term->key_press ($state, $keycode[, $time])
		1502
		1503	=item $term->key_release ($state, $keycode[, $time])
		1504
		1505	Deliver various fake events to to terminal.
		1506
1343	=item $window_width = $term->width	1507	=item $window_width = $term->width
1344		1508
1345	=item $window_height = $term->height	1509	=item $window_height = $term->height
1346		1510
1347	=item $font_width = $term->fwidth	1511	=item $font_width = $term->fwidth
…		…
1377	=item $env = $term->env	1541	=item $env = $term->env
1378		1542
1379	Returns a copy of the environment in effect for the terminal as a hashref	1543	Returns a copy of the environment in effect for the terminal as a hashref
1380	similar to C<\%ENV>.	1544	similar to C<\%ENV>.
1381		1545
		1546	=item @envv = $term->envv
		1547
		1548	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1549
		1550	=item @argv = $term->argv
		1551
		1552	Return the argument vector as this terminal, similar to @ARGV, but
		1553	includes the program name as first element.
		1554
1382	=cut	1555	=cut
1383		1556
1384	sub env {	1557	sub env {
1385	if (my $env = $_[0]->_env) {
1386	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1558	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1387	} else {
1388	+{ %ENV }
1389	}
1390	}	1559	}
1391		1560
1392	=item $modifiermask = $term->ModLevel3Mask	1561	=item $modifiermask = $term->ModLevel3Mask
1393		1562
1394	=item $modifiermask = $term->ModMetaMask	1563	=item $modifiermask = $term->ModMetaMask
…		…
1402		1571
1403	Returns the currently displayed screen (0 primary, 1 secondary).	1572	Returns the currently displayed screen (0 primary, 1 secondary).
1404		1573
1405	=item $cursor_is_hidden = $term->hidden_cursor	1574	=item $cursor_is_hidden = $term->hidden_cursor
1406		1575
1407	Returns wether the cursor is currently hidden or not.	1576	Returns whether the cursor is currently hidden or not.
1408		1577
1409	=item $view_start = $term->view_start ([$newvalue])	1578	=item $view_start = $term->view_start ([$newvalue])
1410		1579
1411	Returns the row number of the topmost displayed line. Maximum value is	1580	Returns the row number of the topmost displayed line. Maximum value is
1412	C<0>, which displays the normal terminal contents. Lower values scroll	1581	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1420		1589
1421	Used after changing terminal contents to display them.	1590	Used after changing terminal contents to display them.
1422		1591
1423	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1592	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1424		1593
1425	Returns the text of the entire row with number C<$row_number>. Row C<0>	1594	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1426	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1595	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1427	terminal line. The scrollback buffer starts at line C<-1> and extends to
1428	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1596	terminal line. Nothing will be returned if a nonexistent line
1429	is requested.	1597	is requested.
1430		1598
1431	If C<$new_text> is specified, it will replace characters in the current	1599	If C<$new_text> is specified, it will replace characters in the current
1432	line, starting at column C<$start_col> (default C<0>), which is useful	1600	line, starting at column C<$start_col> (default C<0>), which is useful
1433	to replace only parts of a line. The font index in the rendition will	1601	to replace only parts of a line. The font index in the rendition will
1434	automatically be updated.	1602	automatically be updated.
1435		1603
1436	C<$text> is in a special encoding: tabs and wide characters that use more	1604	C<$text> is in a special encoding: tabs and wide characters that use more
1437	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1605	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1438	characters. Characters with combining characters and other characters that	1606	characters. Characters with combining characters and other characters that
1439	do not fit into the normal tetx encoding will be replaced with characters	1607	do not fit into the normal text encoding will be replaced with characters
1440	in the private use area.	1608	in the private use area.
1441		1609
1442	You have to obey this encoding when changing text. The advantage is	1610	You have to obey this encoding when changing text. The advantage is
1443	that C<substr> and similar functions work on screen cells and not on	1611	that C<substr> and similar functions work on screen cells and not on
1444	characters.	1612	characters.
…		…
1589	where one character corresponds to one screen cell. See	1757	where one character corresponds to one screen cell. See
1590	C<< $term->ROW_t >> for details.	1758	C<< $term->ROW_t >> for details.
1591		1759
1592	=item $string = $term->special_decode $text	1760	=item $string = $term->special_decode $text
1593		1761
1594	Converts rxvt-unicodes text reprsentation into a perl string. See	1762	Converts rxvt-unicodes text representation into a perl string. See
1595	C<< $term->ROW_t >> for details.	1763	C<< $term->ROW_t >> for details.
1596		1764
1597	=item $success = $term->grab_button ($button, $modifiermask)	1765	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1598		1766
		1767	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1768
1599	Registers a synchronous button grab. See the XGrabButton manpage.	1769	Register/unregister a synchronous button grab. See the XGrabButton
		1770	manpage.
1600		1771
1601	=item $success = $term->grab ($eventtime[, $sync])	1772	=item $success = $term->grab ($eventtime[, $sync])
1602		1773
1603	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1774	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1604	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1775	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1605		1776
1606	=item $term->allow_events_async	1777	=item $term->allow_events_async
1607		1778
1608	Calls XAllowEvents with AsyncBoth for the most recent grab.	1779	Calls XAllowEvents with AsyncBoth for the most recent grab.
1609		1780
…		…
1616	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1787	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1617	recent grab.	1788	recent grab.
1618		1789
1619	=item $term->ungrab	1790	=item $term->ungrab
1620		1791
1621	Calls XUngrab for the most recent grab. Is called automatically on	1792	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1622	evaluation errors, as it is better to lose the grab in the error case as	1793	evaluation errors, as it is better to lose the grab in the error case as
1623	the session.	1794	the session.
1624		1795
1625	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1796	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1626		1797
…		…
1628		1799
1629	=item @atoms = $term->XListProperties ($window)	1800	=item @atoms = $term->XListProperties ($window)
1630		1801
1631	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1802	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1632		1803
1633	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1804	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1634		1805
1635	=item $term->XDeleteProperty ($window, $property)	1806	=item $term->XDeleteProperty ($window, $property)
1636		1807
1637	=item $window = $term->DefaultRootWindow	1808	=item $window = $term->DefaultRootWindow
1638		1809
…		…
1645	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1816	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1646		1817
1647	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1818	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1648		1819
1649	=item $term->XChangeInput ($window, $add_events[, $del_events])	1820	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1821
		1822	=item $keysym = $term->XStringToKeysym ($string)
		1823
		1824	=item $string = $term->XKeysymToString ($keysym)
1650		1825
1651	Various X or X-related functions. The C<$term> object only serves as	1826	Various X or X-related functions. The C<$term> object only serves as
1652	the source of the display, otherwise those functions map more-or-less	1827	the source of the display, otherwise those functions map more-or-less
1653	directory onto the X functions of the same name.	1828	directly onto the X functions of the same name.
1654		1829
1655	=back	1830	=back
1656		1831
1657	=cut	1832	=cut
1658		1833
…		…
1722	my ($self, $text, $cb) = @_;	1897	my ($self, $text, $cb) = @_;
1723		1898
1724	$self->add_item ({ type => "button", text => $text, activate => $cb});	1899	$self->add_item ({ type => "button", text => $text, activate => $cb});
1725	}	1900	}
1726		1901
1727	=item $popup->add_toggle ($text, $cb, $initial_value)	1902	=item $popup->add_toggle ($text, $initial_value, $cb)
1728		1903
1729	Adds a toggle/checkbox item to the popup. Teh callback gets called	1904	Adds a toggle/checkbox item to the popup. The callback gets called
1730	whenever it gets toggled, with a boolean indicating its value as its first	1905	whenever it gets toggled, with a boolean indicating its new value as its
1731	argument.	1906	first argument.
1732		1907
1733	=cut	1908	=cut
1734		1909
1735	sub add_toggle {	1910	sub add_toggle {
1736	my ($self, $text, $cb, $value) = @_;	1911	my ($self, $text, $value, $cb) = @_;
1737		1912
1738	my $item; $item = {	1913	my $item; $item = {
1739	type => "button",	1914	type => "button",
1740	text => " $text",	1915	text => " $text",
1741	value => $value,	1916	value => $value,
…		…
1760	my $env = $self->{term}->env;	1935	my $env = $self->{term}->env;
1761	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1936	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1762	delete $env->{LC_ALL};	1937	delete $env->{LC_ALL};
1763	$env->{LC_CTYPE} = $self->{term}->locale;	1938	$env->{LC_CTYPE} = $self->{term}->locale;
1764		1939
1765	urxvt::term->new ($env, "popup",	1940	my $term = urxvt::term->new (
		1941	$env, "popup",
1766	"--perl-lib" => "", "--perl-ext-common" => "",	1942	"--perl-lib" => "", "--perl-ext-common" => "",
1767	"-pty-fd" => -1, "-sl" => 0,	1943	"-pty-fd" => -1, "-sl" => 0,
1768	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1944	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1769	"--transient-for" => $self->{term}->parent,	1945	"--transient-for" => $self->{term}->parent,
1770	"-display" => $self->{term}->display_id,	1946	"-display" => $self->{term}->display_id,
1771	"-pe" => "urxvt-popup")	1947	"-pe" => "urxvt-popup",
1772	or die "unable to create popup window\n";	1948	) or die "unable to create popup window\n";
		1949
		1950	unless (delete $term->{urxvt_popup_init_done}) {
		1951	$term->ungrab;
		1952	$term->destroy;
		1953	die "unable to initialise popup window\n";
		1954	}
1773	}	1955	}
1774		1956
1775	sub DESTROY {	1957	sub DESTROY {
1776	my ($self) = @_;	1958	my ($self) = @_;
1777		1959
…		…
1782	=back	1964	=back
1783		1965
1784	=cut	1966	=cut
1785		1967
1786	package urxvt::watcher;	1968	package urxvt::watcher;
1787
1788	@urxvt::timer::ISA = __PACKAGE__;
1789	@urxvt::iow::ISA = __PACKAGE__;
1790	@urxvt::pw::ISA = __PACKAGE__;
1791	@urxvt::iw::ISA = __PACKAGE__;
1792		1969
1793	=head2 The C<urxvt::timer> Class	1970	=head2 The C<urxvt::timer> Class
1794		1971
1795	This class implements timer watchers/events. Time is represented as a	1972	This class implements timer watchers/events. Time is represented as a
1796	fractional number of seconds since the epoch. Example:	1973	fractional number of seconds since the epoch. Example:
…		…
1800	->new	1977	->new
1801	->interval (1)	1978	->interval (1)
1802	->cb (sub {	1979	->cb (sub {
1803	$term->{overlay}->set (0, 0,	1980	$term->{overlay}->set (0, 0,
1804	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1981	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1805	});	1982	});
1806		1983
1807	=over 4	1984	=over 4
1808		1985
1809	=item $timer = new urxvt::timer	1986	=item $timer = new urxvt::timer
1810		1987
…		…
1813		1990
1814	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1991	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1815		1992
1816	Set the callback to be called when the timer triggers.	1993	Set the callback to be called when the timer triggers.
1817		1994
1818	=item $tstamp = $timer->at
1819
1820	Return the time this watcher will fire next.
1821
1822	=item $timer = $timer->set ($tstamp)	1995	=item $timer = $timer->set ($tstamp[, $interval])
1823		1996
1824	Set the time the event is generated to $tstamp.	1997	Set the time the event is generated to $tstamp (and optionally specifies a
		1998	new $interval).
1825		1999
1826	=item $timer = $timer->interval ($interval)	2000	=item $timer = $timer->interval ($interval)
1827		2001
1828	Normally (and when C<$interval> is C<0>), the timer will automatically	2002	By default (and when C<$interval> is C<0>), the timer will automatically
1829	stop after it has fired once. If C<$interval> is non-zero, then the timer	2003	stop after it has fired once. If C<$interval> is non-zero, then the timer
1830	is automatically rescheduled at the given intervals.	2004	is automatically rescheduled at the given intervals.
1831		2005
1832	=item $timer = $timer->start	2006	=item $timer = $timer->start
1833		2007
1834	Start the timer.	2008	Start the timer.
1835		2009
1836	=item $timer = $timer->start ($tstamp)	2010	=item $timer = $timer->start ($tstamp[, $interval])
1837		2011
1838	Set the event trigger time to C<$tstamp> and start the timer.	2012	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2013	also replaces the interval.
1839		2014
1840	=item $timer = $timer->after ($delay)	2015	=item $timer = $timer->after ($delay[, $interval])
1841		2016
1842	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2017	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1843		2018
1844	=item $timer = $timer->stop	2019	=item $timer = $timer->stop
1845		2020
…		…
1853		2028
1854	$term->{socket} = ...	2029	$term->{socket} = ...
1855	$term->{iow} = urxvt::iow	2030	$term->{iow} = urxvt::iow
1856	->new	2031	->new
1857	->fd (fileno $term->{socket})	2032	->fd (fileno $term->{socket})
1858	->events (urxvt::EVENT_READ)	2033	->events (urxvt::EV_READ)
1859	->start	2034	->start
1860	->cb (sub {	2035	->cb (sub {
1861	my ($iow, $revents) = @_;	2036	my ($iow, $revents) = @_;
1862	# $revents must be 1 here, no need to check	2037	# $revents must be 1 here, no need to check
1863	sysread $term->{socket}, my $buf, 8192	2038	sysread $term->{socket}, my $buf, 8192
…		…
1876	Set the callback to be called when io events are triggered. C<$reventmask>	2051	Set the callback to be called when io events are triggered. C<$reventmask>
1877	is a bitset as described in the C<events> method.	2052	is a bitset as described in the C<events> method.
1878		2053
1879	=item $iow = $iow->fd ($fd)	2054	=item $iow = $iow->fd ($fd)
1880		2055
1881	Set the filedescriptor (not handle) to watch.	2056	Set the file descriptor (not handle) to watch.
1882		2057
1883	=item $iow = $iow->events ($eventmask)	2058	=item $iow = $iow->events ($eventmask)
1884		2059
1885	Set the event mask to watch. The only allowed values are	2060	Set the event mask to watch. The only allowed values are
1886	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2061	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1887	together, or C<urxvt::EVENT_NONE>.	2062	together, or C<urxvt::EV_NONE>.
1888		2063
1889	=item $iow = $iow->start	2064	=item $iow = $iow->start
1890		2065
1891	Start watching for requested events on the given handle.	2066	Start watching for requested events on the given handle.
1892		2067
1893	=item $iow = $iow->stop	2068	=item $iow = $iow->stop
1894		2069
1895	Stop watching for events on the given filehandle.	2070	Stop watching for events on the given file handle.
1896		2071
1897	=back	2072	=back
1898		2073
1899	=head2 The C<urxvt::iw> Class	2074	=head2 The C<urxvt::iw> Class
1900		2075
…		…
1933	->new	2108	->new
1934	->start ($pid)	2109	->start ($pid)
1935	->cb (sub {	2110	->cb (sub {
1936	my ($pw, $exit_status) = @_;	2111	my ($pw, $exit_status) = @_;
1937	...	2112	...
1938	});	2113	});
1939		2114
1940	=over 4	2115	=over 4
1941		2116
1942	=item $pw = new urxvt::pw	2117	=item $pw = new urxvt::pw
1943		2118
…		…
1947		2122
1948	Set the callback to be called when the timer triggers.	2123	Set the callback to be called when the timer triggers.
1949		2124
1950	=item $pw = $timer->start ($pid)	2125	=item $pw = $timer->start ($pid)
1951		2126
1952	Tells the wqtcher to start watching for process C<$pid>.	2127	Tells the watcher to start watching for process C<$pid>.
1953		2128
1954	=item $pw = $pw->stop	2129	=item $pw = $pw->stop
1955		2130
1956	Stop the watcher.	2131	Stop the watcher.
1957		2132
…		…
1970		2145
1971	=item >= 3 - script loading and management	2146	=item >= 3 - script loading and management
1972		2147
1973	=item >=10 - all called hooks	2148	=item >=10 - all called hooks
1974		2149
1975	=item >=11 - hook reutrn values	2150	=item >=11 - hook return values
1976		2151
1977	=back	2152	=back
1978		2153
1979	=head1 AUTHOR	2154	=head1 AUTHOR
1980		2155
1981	Marc Lehmann <pcg@goof.com>	2156	Marc Lehmann <schmorp@schmorp.de>
1982	http://software.schmorp.de/pkg/rxvt-unicode	2157	http://software.schmorp.de/pkg/rxvt-unicode
1983		2158
1984	=cut	2159	=cut
1985		2160
1986	1	2161	1
		2162
		2163	# vim: sw=3:

Diff Legend

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