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.129 by root, Wed Jan 25 15:11:31 2006 UTC vs.
Revision 1.218 by root, Sun Jun 10 17:31:53 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 vewiwed
		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	laoded 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 remote-selection
248
249	Somewhat of a misnomer, this extension adds two menu entries to the
250	selection popup that allows one ti run external commands to store the
251	selection somewhere and fetch it again.
252
253	We use it to implement a "distributed selection mechanism", which just
254	means that one command uploads the file to a remote server, and another
255	reads it.
256
257	The commands can be set using the C<URxvt.remote-selection.store> and
258	C<URxvt.remote-selection.fetch> resources. The first should read the
259	selection to store from STDIN (always in UTF-8), the second should provide
260	the selection data on STDOUT (also in UTF-8).
261
262	The defaults (which are likely useless to you) use rsh and cat:
263
264	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
265	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
266
267	=item selection-pastebin
268
269	This is a little rarely useful extension that Uploads the selection as
270	textfile to a remote site (or does other things). (The implementation is
271	not currently secure for use in a multiuser environment as it writes to
272	F</tmp> directly.).
273
274	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
275	i.e.
276
277	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
278
279	Pressing this combination runs a command with C<%> replaced by the name of
280	the textfile. This command can be set via a resource:
281
282	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
283
284	And the default is likely not useful to anybody but the few people around
285	here :)
286
287	The name of the textfile is the hex encoded md5 sum of the selection, so
288	the same content should lead to the same filename.
289
290	After a successful upload the selection will be replaced by the text given
291	in the C<selection-pastebin-url> resource (again, the % is the placeholder
292	for the filename):
293
294	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
295
296	=item example-refresh-hooks
297
298	Displays a very simple digital clock in the upper right corner of the
299	window. Illustrates overwriting the refresh callbacks to create your own
300	overlays or changes.
301
302	=back
303		50
304	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
305		52
306	=head2 General API Considerations	53	=head2 General API Considerations
307		54
…		…
321		68
322	=over 4	69	=over 4
323		70
324	=item $text	71	=item $text
325		72
326	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
327	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.
328		75
329	=item $string	76	=item $string
330		77
331	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
…		…
335	=item $octets	82	=item $octets
336		83
337	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
338	locale-specific way.	85	locale-specific way.
339		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
340	=back	93	=back
341		94
342	=head2 Extension Objects	95	=head2 Extension Objects
343		96
344	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
345	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,
346	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
347	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
348	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
349	use.	103	internal use.
350		104
351	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
352	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
353		107
354	It has the following methods and data members:	108	It has the following methods and data members:
…		…
375	=head2 Hooks	129	=head2 Hooks
376		130
377	The following subroutines can be declared in extension files, and will be	131	The following subroutines can be declared in extension files, and will be
378	called whenever the relevant event happens.	132	called whenever the relevant event happens.
379		133
380	The first argument passed to them is an extension oject as described in	134	The first argument passed to them is an extension object as described in
381	the in the C<Extension Objects> section.	135	the in the C<Extension Objects> section.
382		136
383	B<All> of these hooks must return a boolean value. If any of the called	137	B<All> of these hooks must return a boolean value. If any of the called
384	hooks returns true, then the event counts as being I<consumed>, and the	138	hooks returns true, then the event counts as being I<consumed>, and the
385	relevant action might not be carried out by the C++ code.	139	relevant action might not be carried out by the C++ code.
…		…
398	place.	152	place.
399		153
400	=item on_start $term	154	=item on_start $term
401		155
402	Called at the very end of initialisation of a new terminal, just before	156	Called at the very end of initialisation of a new terminal, just before
403	trying to map (display) the toplevel and returning to the mainloop.	157	trying to map (display) the toplevel and returning to the main loop.
404		158
405	=item on_destroy $term	159	=item on_destroy $term
406		160
407	Called whenever something tries to destroy terminal, when the terminal is	161	Called whenever something tries to destroy terminal, when the terminal is
408	still fully functional (not for long, though).	162	still fully functional (not for long, though).
…		…
435		189
436	Called whenever a selection has been copied, but before the selection is	190	Called whenever a selection has been copied, but before the selection is
437	requested from the server. The selection text can be queried and changed	191	requested from the server. The selection text can be queried and changed
438	by calling C<< $term->selection >>.	192	by calling C<< $term->selection >>.
439		193
440	Returning a true value aborts selection grabbing. It will still be hilighted.	194	Returning a true value aborts selection grabbing. It will still be highlighted.
441		195
442	=item on_sel_extend $term	196	=item on_sel_extend $term
443		197
444	Called whenever the user tries to extend the selection (e.g. with a double	198	Called whenever the user tries to extend the selection (e.g. with a double
445	click) and is either supposed to return false (normal operation), or	199	click) and is either supposed to return false (normal operation), or
446	should extend the selection itelf and return true to suppress the built-in	200	should extend the selection itself and return true to suppress the built-in
447	processing. This can happen multiple times, as long as the callback	201	processing. This can happen multiple times, as long as the callback
448	returns true, it will be called on every further click by the user and is	202	returns true, it will be called on every further click by the user and is
449	supposed to enlarge the selection more and more, if possible.	203	supposed to enlarge the selection more and more, if possible.
450		204
451	See the F<selection> example extension.	205	See the F<selection> example extension.
452		206
453	=item on_view_change $term, $offset	207	=item on_view_change $term, $offset
454		208
455	Called whenever the view offset changes, i..e the user or program	209	Called whenever the view offset changes, i.e. the user or program
456	scrolls. Offset C<0> means display the normal terminal, positive values	210	scrolls. Offset C<0> means display the normal terminal, positive values
457	show this many lines of scrollback.	211	show this many lines of scrollback.
458		212
459	=item on_scroll_back $term, $lines, $saved	213	=item on_scroll_back $term, $lines, $saved
460		214
…		…
464		218
465	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	219	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
466	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	220	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
467	number of lines that will be in the scrollback buffer.	221	number of lines that will be in the scrollback buffer.
468		222
469	=item on_osc_seq $term, $string	223	=item on_osc_seq $term, $op, $args, $resp
		224
		225	Called on every OSC sequence and can be used to suppress it or modify its
		226	behaviour. The default should be to return an empty list. A true value
		227	suppresses execution of the request completely. Make sure you don't get
		228	confused by recursive invocations when you output an OSC sequence within
		229	this callback.
		230
		231	C<on_osc_seq_perl> should be used for new behaviour.
		232
		233	=item on_osc_seq_perl $term, $args, $resp
470		234
471	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
472	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
473	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
474	string should start with the extension name and a colon, to distinguish	238	string should start with the extension name (sans -osc) and a semicolon,
475	it from commands for other extensions, and this might be enforced in the	239	to distinguish it from commands for other extensions, and this might be
476	future.	240	enforced in the future.
		241
		242	For example, C<overlay-osc> uses this:
		243
		244	sub on_osc_seq_perl {
		245	my ($self, $osc, $resp) = @_;
		246
		247	return unless $osc =~ s/^overlay;//;
		248
		249	... process remaining $osc string
		250	}
477		251
478	Be careful not ever to trust (in a security sense) the data you receive,	252	Be careful not ever to trust (in a security sense) the data you receive,
479	as its source can not easily be controleld (e-mail content, messages from	253	as its source can not easily be controlled (e-mail content, messages from
480	other users on the same system etc.).	254	other users on the same system etc.).
		255
		256	For responses, C<$resp> contains the end-of-args separator used by the
		257	sender.
481		258
482	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
483		260
484	Called whenever text is about to be output, with the text as argument. You	261	Called whenever text is about to be output, with the text as argument. You
485	can filter/change and output the text yourself by returning a true value	262	can filter/change and output the text yourself by returning a true value
…		…
490	=item on_tt_write $term, $octets	267	=item on_tt_write $term, $octets
491		268
492	Called whenever some data is written to the tty/pty and can be used to	269	Called whenever some data is written to the tty/pty and can be used to
493	suppress or filter tty input.	270	suppress or filter tty input.
494		271
		272	=item on_tt_paste $term, $octets
		273
		274	Called whenever text is about to be pasted, with the text as argument. You
		275	can filter/change and paste the text yourself by returning a true value
		276	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		277	locale-encoded.
		278
495	=item on_line_update $term, $row	279	=item on_line_update $term, $row
496		280
497	Called whenever a line was updated or changed. Can be used to filter	281	Called whenever a line was updated or changed. Can be used to filter
498	screen output (e.g. underline urls or other useless stuff). Only lines	282	screen output (e.g. underline urls or other useless stuff). Only lines
499	that are being shown will be filtered, and, due to performance reasons,	283	that are being shown will be filtered, and, due to performance reasons,
…		…
506	later with the already-modified line (e.g. if unrelated parts change), so	290	later with the already-modified line (e.g. if unrelated parts change), so
507	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
508		292
509	=item on_refresh_begin $term	293	=item on_refresh_begin $term
510		294
511	Called just before the screen gets redrawn. Can be used for overlay	295	Called just before the screen gets redrawn. Can be used for overlay or
512	or similar effects by modify terminal contents in refresh_begin, and	296	similar effects by modifying the terminal contents in refresh_begin, and
513	restoring them in refresh_end. The built-in overlay and selection display	297	restoring them in refresh_end. The built-in overlay and selection display
514	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
515		299
516	=item on_refresh_end $term	300	=item on_refresh_end $term
517		301
518	Called just after the screen gets redrawn. See C<on_refresh_begin>.	302	Called just after the screen gets redrawn. See C<on_refresh_begin>.
519		303
520	=item on_keyboard_command $term, $string	304	=item on_user_command $term, $string
521		305
522	Called whenever the user presses a key combination that has a	306	Called whenever a user-configured event is being activated (e.g. via
523	C<perl:string> action bound to it (see description of the B<keysym>	307	a C<perl:string> action bound to a key, see description of the B<keysym>
524	resource in the @@RXVT_NAME@@(1) manpage).	308	resource in the @@RXVT_NAME@@(1) manpage).
		309
		310	The event is simply the action string. This interface is assumed to change
		311	slightly in the future.
		312
		313	=item on_register_command $term, $keysym, $modifiermask, $string
		314
		315	Called after parsing a keysym resource but before registering the
		316	associated binding. If this hook returns TRUE the binding is not
		317	registered. It can be used to modify a binding by calling
		318	C<register_command>.
		319
		320	=item on_resize_all_windows $term, $new_width, $new_height
		321
		322	Called just after the new window size has been calculated, but before
		323	windows are actually being resized or hints are being set. If this hook
		324	returns TRUE, setting of the window hints is being skipped.
525		325
526	=item on_x_event $term, $event	326	=item on_x_event $term, $event
527		327
528	Called on every X event received on the vt window (and possibly other	328	Called on every X event received on the vt window (and possibly other
529	windows). Should only be used as a last resort. Most event structure	329	windows). Should only be used as a last resort. Most event structure
530	members are not passed.	330	members are not passed.
531		331
		332	=item on_root_event $term, $event
		333
		334	Like C<on_x_event>, but is called for events on the root window.
		335
532	=item on_focus_in $term	336	=item on_focus_in $term
533		337
534	Called whenever the window gets the keyboard focus, before rxvt-unicode	338	Called whenever the window gets the keyboard focus, before rxvt-unicode
535	does focus in processing.	339	does focus in processing.
536		340
537	=item on_focus_out $term	341	=item on_focus_out $term
538		342
539	Called wheneever the window loses keyboard focus, before rxvt-unicode does	343	Called whenever the window loses keyboard focus, before rxvt-unicode does
540	focus out processing.	344	focus out processing.
541		345
542	=item on_configure_notify $term, $event	346	=item on_configure_notify $term, $event
543		347
544	=item on_property_notify $term, $event	348	=item on_property_notify $term, $event
…		…
555		359
556	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
557		361
558	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
559		363
560	Called whenever the corresponding X event is received for the terminal If	364	Called whenever the corresponding X event is received for the terminal. If
561	the hook returns true, then the even will be ignored by rxvt-unicode.	365	the hook returns true, then the event will be ignored by rxvt-unicode.
562		366
563	The event is a hash with most values as named by Xlib (see the XEvent	367	The event is a hash with most values as named by Xlib (see the XEvent
564	manpage), with the additional members C<row> and C<col>, which are the	368	manpage), with the additional members C<row> and C<col>, which are the
565	(real, not screen-based) row and column under the mouse cursor.	369	(real, not screen-based) row and column under the mouse cursor.
566		370
…		…
576	=item on_wm_delete_window $term, $event	380	=item on_wm_delete_window $term, $event
577		381
578	Called when various types of ClientMessage events are received (all with	382	Called when various types of ClientMessage events are received (all with
579	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	383	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
580		384
		385	=item on_bell $term
		386
		387	Called on receipt of a bell character.
		388
581	=back	389	=back
582		390
583	=cut	391	=cut
584		392
585	package urxvt;	393	package urxvt;
586		394
587	use utf8;	395	use utf8;
588	use strict;	396	use strict 'vars';
589	use Carp ();	397	use Carp ();
590	use Scalar::Util ();	398	use Scalar::Util ();
591	use List::Util ();	399	use List::Util ();
592		400
593	our $VERSION = 1;	401	our $VERSION = 1;
594	our $TERM;	402	our $TERM;
595	our @TERM_INIT;	403	our @TERM_INIT; # should go, prevents async I/O etc.
596	our @TERM_EXT;	404	our @TERM_EXT; # should go, prevents async I/O etc.
597	our @HOOKNAME;	405	our @HOOKNAME;
598	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
599	our %OPTION;	407	our %OPTION;
600		408
601	our $LIBDIR;	409	our $LIBDIR;
…		…
627	The current terminal. This variable stores the current C<urxvt::term>	435	The current terminal. This variable stores the current C<urxvt::term>
628	object, whenever a callback/hook is executing.	436	object, whenever a callback/hook is executing.
629		437
630	=item @urxvt::TERM_INIT	438	=item @urxvt::TERM_INIT
631		439
632	All coderefs in this array will be called as methods of the next newly	440	All code references in this array will be called as methods of the next newly
633	created C<urxvt::term> object (during the C<on_init> phase). The array	441	created C<urxvt::term> object (during the C<on_init> phase). The array
634	gets cleared before the codereferences that were in it are being executed,	442	gets cleared before the code references that were in it are being executed,
635	so coderefs can push themselves onto it again if they so desire.	443	so references can push themselves onto it again if they so desire.
636		444
637	This complements to the perl-eval commandline option, but gets executed	445	This complements to the perl-eval command line option, but gets executed
638	first.	446	first.
639		447
640	=item @urxvt::TERM_EXT	448	=item @urxvt::TERM_EXT
641		449
642	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	450	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
649		457
650	=over 4	458	=over 4
651		459
652	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
653		461
654	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
655	costs! The only time this is acceptable is when the terminal process	463	include a trailing newline). Avoid at all costs! The only time this
656	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
657		466
658	=item urxvt::warn $string	467	=item urxvt::warn $string
659		468
660	Calls C<rxvt_warn> with the given string which should not include a	469	Calls C<rxvt_warn> with the given string which should include a trailing
661	newline. The module also overwrites the C<warn> builtin with a function	470	newline. The module also overwrites the C<warn> builtin with a function
662	that calls this function.	471	that calls this function.
663		472
664	Using this function has the advantage that its output ends up in the	473	Using this function has the advantage that its output ends up in the
665	correct place, e.g. on stderr of the connecting urxvtc client.	474	correct place, e.g. on stderr of the connecting urxvtc client.
666		475
667	Messages have a size limit of 1023 bytes currently.	476	Messages have a size limit of 1023 bytes currently.
		477
		478	=item @terms = urxvt::termlist
		479
		480	Returns all urxvt::term objects that exist in this process, regardless of
		481	whether they are started, being destroyed etc., so be careful. Only term
		482	objects that have perl extensions attached will be returned (because there
		483	is no urxvt::term object associated with others).
668		484
669	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
670		486
671	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
672		488
…		…
715		531
716	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
717		533
718	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
719		535
720	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	536	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		537	urxvt::RS_RVid, urxvt::RS_Uline
721		538
722	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
723	underline, respectively. To enable such a style, just logically OR it into	540	underline, respectively. To enable such a style, just logically OR it into
724	the bitset.	541	the bitset.
725		542
…		…
730	Return the foreground/background colour index, respectively.	547	Return the foreground/background colour index, respectively.
731		548
732	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	549	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
733		550
734	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	551	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		552
		553	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
735		554
736	Replace the foreground/background colour in the rendition mask with the	555	Replace the foreground/background colour in the rendition mask with the
737	specified one.	556	specified one.
738		557
739	=item $value = urxvt::GET_CUSTOM $rend	558	=item $value = urxvt::GET_CUSTOM $rend
…		…
760	};	579	};
761	}	580	}
762		581
763	no warnings 'utf8';	582	no warnings 'utf8';
764		583
		584	sub parse_resource {
		585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		586
		587	$name =~ y/-/./ if $isarg;
		588
		589	$term->scan_meta;
		590
		591	my $r = $term->{meta}{resource};
		592	keys %$r; # reste iterator
		593	while (my ($pattern, $v) = each %$r) {
		594	if (
		595	$pattern =~ /\.$/
		596	? $pattern eq substr $name, 0, length $pattern
		597	: $pattern eq $name
		598	) {
		599	$name = "$urxvt::RESCLASS.$name";
		600
		601	push @{ $term->{perl_ext_3} }, $v->[0];
		602
		603	if ($v->[1] eq "boolean") {
		604	$term->put_option_db ($name, $flag ? "true" : "false");
		605	return 1;
		606	} else {
		607	$term->put_option_db ($name, $value);
		608	return 1 + 2;
		609	}
		610	}
		611	}
		612
		613	0
		614	}
		615
		616	sub usage {
		617	my ($term, $usage_type) = @_;
		618
		619	$term->scan_meta;
		620
		621	my $r = $term->{meta}{resource};
		622
		623	for my $pattern (sort keys %$r) {
		624	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		625
		626	$desc .= " (-pe $ext)";
		627
		628	if ($usage_type == 1) {
		629	$pattern =~ y/./-/;
		630	$pattern =~ s/-$/-.../g;
		631
		632	if ($type eq "boolean") {
		633	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		634	} else {
		635	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		636	}
		637	} else {
		638	$pattern =~ s/\.$/.*/g;
		639	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		640	}
		641	}
		642	}
		643
765	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
766		645
767	sub verbose {	646	sub verbose {
768	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
769	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
…		…
781	$pkg =~ s/[^[:word:]]/_/g;	660	$pkg =~ s/[^[:word:]]/_/g;
782	$pkg = "urxvt::ext::$pkg";	661	$pkg = "urxvt::ext::$pkg";
783		662
784	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
785		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		666
786	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
787	or die "$path: $!";	668	or die "$path: $!";
788		669
789	my $source =	670	my $source =
790	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
791	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
792	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
793	. "\n};\n1";	674	. "\n};\n1";
794		675
795	eval $source	676	eval $source
…		…
805	sub invoke {	686	sub invoke {
806	local $TERM = shift;	687	local $TERM = shift;
807	my $htype = shift;	688	my $htype = shift;
808		689
809	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
810	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
811		692
812	my %ext_arg;	693	my %ext_arg;
813		694
814	{	695	{
815	my @init = @TERM_INIT;	696	my @init = @TERM_INIT;
816	@TERM_INIT = ();	697	@TERM_INIT = ();
…		…
818	my @pkg = @TERM_EXT;	699	my @pkg = @TERM_EXT;
819	@TERM_EXT = ();	700	@TERM_EXT = ();
820	$TERM->register_package ($_) for @pkg;	701	$TERM->register_package ($_) for @pkg;
821	}	702	}
822		703
		704	for (
		705	@{ delete $TERM->{perl_ext_3} },
823	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
824	if ($_ eq "default") {	708	if ($_ eq "default") {
825	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	709	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
826	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
827	delete $ext_arg{$1};	711	delete $ext_arg{$1};
828	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
…		…
830	} else {	714	} else {
831	$ext_arg{$_} ||= [];	715	$ext_arg{$_} ||= [];
832	}	716	}
833	}	717	}
834		718
835	while (my ($ext, $argv) = each %ext_arg) {	719	for my $ext (sort keys %ext_arg) {
836	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
837		721
838	if (@files) {	722	if (@files) {
839	$TERM->register_package (extension_package $files[0], $argv);	723	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
840	} else {	724	} else {
841	warn "perl extension '$ext' not found in perl library search path\n";	725	warn "perl extension '$ext' not found in perl library search path\n";
842	}	726	}
843	}	727	}
844		728
…		…
850		734
851	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
852	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
853	if $verbosity >= 10;	737	if $verbosity >= 10;
854		738
855	keys %$cb;	739	for my $pkg (keys %$cb) {
856
857	while (my ($pkg, $cb) = each %$cb) {
858	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
859	$retval ||= $retval_;	741	$retval ||= $retval_;
860		742
861	if ($@) {	743	if ($@) {
862	$TERM->ungrab; # better to lose the grab than the session	744	$TERM->ungrab; # better to lose the grab than the session
863	warn $@;	745	warn $@;
…		…
877	}	759	}
878		760
879	$retval	761	$retval
880	}	762	}
881		763
882	# urxvt::term::extension	764	sub SET_COLOR($$$) {
		765	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		766	}
		767
		768	sub rend2mask {
		769	no strict 'refs';
		770	my ($str, $mask) = (@_, 0);
		771	my %color = ( fg => undef, bg => undef );
		772	my @failed;
		773	for my $spec ( split /\s+/, $str ) {
		774	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		775	$color{lc($1)} = $2;
		776	} else {
		777	my $neg = $spec =~ s/^[-^]//;
		778	unless ( exists &{"RS_$spec"} ) {
		779	push @failed, $spec;
		780	next;
		781	}
		782	my $cur = &{"RS_$spec"};
		783	if ( $neg ) {
		784	$mask &= ~$cur;
		785	} else {
		786	$mask |= $cur;
		787	}
		788	}
		789	}
		790	($mask, @color{qw(fg bg)}, \@failed)
		791	}
883		792
884	package urxvt::term::extension;	793	package urxvt::term::extension;
885		794
886	sub enable {	795	sub enable {
887	my ($self, %hook) = @_;	796	my ($self, %hook) = @_;
…		…
942		851
943	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
944	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
945	}	854	}
946		855
		856	sub x_resource {
		857	my ($self, $name) = @_;
		858	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		859	$self->{term}->x_resource ($name)
		860	}
		861
		862	sub x_resource_boolean {
		863	my ($self, $name) = @_;
		864	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		865	$self->{term}->x_resource_boolean ($name)
		866	}
		867
947	package urxvt::anyevent;	868	package urxvt::anyevent;
948		869
949	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
950		871
951	The sole purpose of this class is to deliver an interface to the	872	The sole purpose of this class is to deliver an interface to the
952	C<AnyEvent> module - any module using it will work inside urxvt without	873	C<AnyEvent> module - any module using it will work inside urxvt without
953	further programming. The only exception is that you cannot wait on	874	further programming. The only exception is that you cannot wait on
954	condition variables, but non-blocking condvar use is ok. What this means	875	condition variables, but non-blocking condvar use is ok.
955	is that you cannot use blocking APIs, but the non-blocking variant should	876
956	work.	877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
957		879
958	=cut	880	=cut
959		881
960	our $VERSION = 1;	882	our $VERSION = '5.23';
961		883
962	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
963	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
964		886
965	sub timer {	887	sub timer {
…		…
967		889
968	my $cb = $arg{cb};	890	my $cb = $arg{cb};
969		891
970	urxvt::timer	892	urxvt::timer
971	->new	893	->new
972	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
973	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
974	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
975	$cb->();	897	$cb->();
976	})	898	})
977	}	899	}
978		900
979	sub io {	901	sub io {
980	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
981		903
982	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
983		907
984	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
985	->new	909	->new
986	->fd (fileno $arg{fh})	910	->fd ($fd)
987	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
988	| ($arg{poll} =~ /w/ ? 2 : 0))	912	| ($arg{poll} =~ /w/ ? 2 : 0))
989	->start	913	->start
990	->cb (sub {	914	->cb ($cb)
991	$cb->(($_[1] & 1 ? 'r' : '')
992	. ($_[1] & 2 ? 'w' : ''));
993	})],
994	urxvt::anyevent::	915	], urxvt::anyevent::
		916	}
		917
		918	sub idle {
		919	my ($class, %arg) = @_;
		920
		921	my $cb = $arg{cb};
		922
		923	urxvt::iw
		924	->new
		925	->start
		926	->cb ($cb)
		927	}
		928
		929	sub child {
		930	my ($class, %arg) = @_;
		931
		932	my $cb = $arg{cb};
		933
		934	urxvt::pw
		935	->new
		936	->start ($arg{pid})
		937	->cb (sub {
		938	$_[0]->stop; # need to cancel manually
		939	$cb->($_[0]->rpid, $_[0]->rstatus);
		940	})
995	}	941	}
996		942
997	sub DESTROY {	943	sub DESTROY {
998	$_[0][1]->stop;	944	$_[0][1]->stop;
999	}	945	}
1000		946
1001	sub condvar {	947	# only needed for AnyEvent < 6 compatibility
1002	bless \my $flag, urxvt::anyevent::condvar::	948	sub one_event {
1003	}
1004
1005	sub urxvt::anyevent::condvar::broadcast {
1006	${$_[0]}++;
1007	}
1008
1009	sub urxvt::anyevent::condvar::wait {
1010	unless (${$_[0]}) {
1011	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	949	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1012	}
1013	}	950	}
1014		951
1015	package urxvt::term;	952	package urxvt::term;
1016		953
1017	=head2 The C<urxvt::term> Class	954	=head2 The C<urxvt::term> Class
…		…
1030	urxvt::verbose 6, "register package $pkg to $self";	967	urxvt::verbose 6, "register package $pkg to $self";
1031		968
1032	@{"$pkg\::ISA"} = urxvt::term::extension::;	969	@{"$pkg\::ISA"} = urxvt::term::extension::;
1033		970
1034	my $proxy = bless {	971	my $proxy = bless {
1035	_pkg => $pkg,	972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
1036	argv => $argv,	974	argv => $argv,
1037	}, $pkg;	975	}, $pkg;
1038	Scalar::Util::weaken ($proxy->{term} = $self);	976	Scalar::Util::weaken ($proxy->{term} = $self);
1039		977
1040	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
1041		979
…		…
1044	$proxy->enable ($name => $ref);	982	$proxy->enable ($name => $ref);
1045	}	983	}
1046	}	984	}
1047	}	985	}
1048		986
		987	sub perl_libdirs {
		988	map { split /:/ }
		989	$_[0]->resource ("perl_lib"),
		990	$ENV{URXVT_PERL_LIB},
		991	"$ENV{HOME}/.urxvt/ext",
		992	"$LIBDIR/perl"
		993	}
		994
		995	sub scan_meta {
		996	my ($self) = @_;
		997	my @libdirs = perl_libdirs $self;
		998
		999	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1000
		1001	my %meta;
		1002
		1003	$self->{meta_libdirs} = join "\x00", @libdirs;
		1004	$self->{meta} = \%meta;
		1005
		1006	for my $dir (reverse @libdirs) {
		1007	opendir my $fh, $dir
		1008	or next;
		1009	for my $ext (readdir $fh) {
		1010	$ext ne "."
		1011	and $ext ne ".."
		1012	and open my $fh, "<", "$dir/$ext"
		1013	or next;
		1014
		1015	while (<$fh>) {
		1016	if (/^#:META:X_RESOURCE:(.*)/) {
		1017	my ($pattern, $type, $desc) = split /:/, $1;
		1018	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1020	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1021	} else {
		1022	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1023	}
		1024	} elsif (/^\s*(?:#|$)/) {
		1025	# skip other comments and empty lines
		1026	} else {
		1027	last; # stop parsing on first non-empty non-comment line
		1028	}
		1029	}
		1030	}
		1031	}
		1032	}
		1033
1049	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1050		1035
1051	Creates a new terminal, very similar as if you had started it with system	1036	Creates a new terminal, very similar as if you had started it with system
1052	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1037	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1053	hash which defines the environment of the new terminal.	1038	hash which defines the environment of the new terminal.
1054		1039
1055	Croaks (and probably outputs an error message) if the new instance	1040	Croaks (and probably outputs an error message) if the new instance
1056	couldn't be created. Returns C<undef> if the new instance didn't	1041	couldn't be created. Returns C<undef> if the new instance didn't
1057	initialise perl, and the terminal object otherwise. The C<init> and	1042	initialise perl, and the terminal object otherwise. The C<init> and
1058	C<start> hooks will be called during this call.	1043	C<start> hooks will be called before this call returns, and are free to
		1044	refer to global data (which is race free).
1059		1045
1060	=cut	1046	=cut
1061		1047
1062	sub new {	1048	sub new {
1063	my ($class, $env, @args) = @_;	1049	my ($class, $env, @args) = @_;
1064		1050
		1051	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1052	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1053
1065	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1054	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1066	}	1055	}
1067		1056
1068	=item $term->destroy	1057	=item $term->destroy
1069		1058
1070	Destroy the terminal object (close the window, free resources	1059	Destroy the terminal object (close the window, free resources
…		…
1100		1089
1101	Returns true if the option specified by C<$optval> is enabled, and	1090	Returns true if the option specified by C<$optval> is enabled, and
1102	optionally change it. All option values are stored by name in the hash	1091	optionally change it. All option values are stored by name in the hash
1103	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1092	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1104		1093
1105	Here is a a likely non-exhaustive list of option names, please see the	1094	Here is a likely non-exhaustive list of option names, please see the
1106	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
1107		1096
1108	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
1109	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1110	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1111	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1112	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1113	transparent tripleclickwords utmpInhibit visualBell	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1103	urgentOnBell utmpInhibit visualBell
1114		1104
1115	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
1116		1106
1117	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
1118	optionally sets a new value. Setting values is most useful in the C<init>	1108	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1127	likely change).	1117	likely change).
1128		1118
1129	Please note that resource strings will currently only be freed when the	1119	Please note that resource strings will currently only be freed when the
1130	terminal is destroyed, so changing options frequently will eat memory.	1120	terminal is destroyed, so changing options frequently will eat memory.
1131		1121
1132	Here is a a likely non-exhaustive list of resource names, not all of which	1122	Here is a likely non-exhaustive list of resource names, not all of which
1133	are supported in every build, please see the source file F</src/rsinc.h>	1123	are supported in every build, please see the source file F</src/rsinc.h>
1134	to see the actual list:	1124	to see the actual list:
1135		1125
1136	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1137	borderLess color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1138	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1139	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1140	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1141	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1142	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1143	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1144	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1145	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1146	secondaryScreen secondaryScroll selectstyle shade term_name title	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1147	transient_for transparent transparent_all tripleclickwords utmpInhibit	1138	term_name title transient_for transparent tripleclickwords urgentOnBell
1148	visualBell	1139	utmpInhibit visualBell
1149		1140
1150	=cut	1141	=cut
1151		1142
1152	sub resource($$;$) {	1143	sub resource($$;$) {
1153	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
1154	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1145	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1155	&urxvt::term::_resource	1146	goto &urxvt::term::_resource
1156	}	1147	}
1157		1148
1158	=item $value = $term->x_resource ($pattern)	1149	=item $value = $term->x_resource ($pattern)
1159		1150
1160	Returns the X-Resource for the given pattern, excluding the program or	1151	Returns the X-Resource for the given pattern, excluding the program or
1161	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1152	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1162	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1153	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1163	resource with that pattern exists.	1154	resource with that pattern exists.
1164		1155
		1156	Extensions that define extra resource or command line arguments also need
		1157	to call this method to access their values.
		1158
		1159	If the method is called on an extension object (basically, from an
		1160	extension), then the special prefix C<%.> will be replaced by the name of
		1161	the extension and a dot, and the lone string C<%> will be replcaed by the
		1162	extension name itself. This makes it possible to code extensions so you
		1163	can rename them and get a new set of commandline switches and resources
		1164	without having to change the actual code.
		1165
1165	This method should only be called during the C<on_start> hook, as there is	1166	This method should only be called during the C<on_start> hook, as there is
1166	only one resource database per display, and later invocations might return	1167	only one resource database per display, and later invocations might return
1167	the wrong resources.	1168	the wrong resources.
1168		1169
1169	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1170	=item $value = $term->x_resource_boolean ($pattern)
1170		1171
		1172	Like C<x_resource>, above, but interprets the string value as a boolean
		1173	and returns C<1> for true values, C<0> for false values and C<undef> if
		1174	the resource or option isn't specified.
		1175
		1176	You should always use this method to parse boolean resources.
		1177
		1178	=cut
		1179
		1180	sub x_resource_boolean {
		1181	my $res = &x_resource;
		1182
		1183	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1184	}
		1185
		1186	=item $success = $term->parse_keysym ($key, $octets)
		1187
1171	Adds a keymap translation exactly as specified via a resource. See the	1188	Adds a key binding exactly as specified via a resource. See the
1172	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1190
		1191	=item $term->register_command ($keysym, $modifiermask, $string)
		1192
		1193	Adds a key binding. This is a lower level api compared to
		1194	C<parse_keysym>, as it expects a parsed key description, and can be
		1195	used only inside either the C<on_init> hook, to add a binding, or the
		1196	C<on_register_command> hook, to modify a parsed binding.
1173		1197
1174	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
1175		1199
1176	Return and optionally change the current rendition. Text that is output by	1200	Return and optionally change the current rendition. Text that is output by
1177	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
1185		1209
1186	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
1187		1211
1188	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
1189		1213
1190	Return the current values of the selection mark, begin or end positions,	1214	Return the current values of the selection mark, begin or end positions.
1191	and optionally set them to new values.	1215
		1216	When arguments are given, then the selection coordinates are set to
		1217	C<$row> and C<$col>, and the selection screen is set to the current
		1218	screen.
		1219
		1220	=item $screen = $term->selection_screen ([$screen])
		1221
		1222	Returns the current selection screen, and then optionally sets it.
1192		1223
1193	=item $term->selection_make ($eventtime[, $rectangular])	1224	=item $term->selection_make ($eventtime[, $rectangular])
1194		1225
1195	Tries to make a selection as set by C<selection_beg> and	1226	Tries to make a selection as set by C<selection_beg> and
1196	C<selection_end>. If C<$rectangular> is true (default: false), a	1227	C<selection_end>. If C<$rectangular> is true (default: false), a
1197	rectangular selection will be made. This is the prefered function to make	1228	rectangular selection will be made. This is the preferred function to make
1198	a selection.	1229	a selection.
1199		1230
1200	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1201		1232
1202	Try to request the primary selection text from the server (for example, as	1233	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1234	true) selection from the server. The corresponding text can be set
1203	set by the next method). No visual feedback will be given. This function	1235	with the next method. No visual feedback will be given. This function
1204	is mostly useful from within C<on_sel_grab> hooks.	1236	is mostly useful from within C<on_sel_grab> hooks.
1205		1237
1206	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
1207		1239
1208	Return the current selection text and optionally replace it by C<$newtext>.	1240	Return the current selection (clipboard if C<$clipboard> is true) text
		1241	and optionally replace it by C<$newtext>.
		1242
		1243	=item $term->selection_clear ([$clipboard])
		1244
		1245	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1209		1246
1210	=item $term->overlay_simple ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
1211		1248
1212	Create a simple multi-line overlay box. See the next method for details.	1249	Create a simple multi-line overlay box. See the next method for details.
1213		1250
…		…
1243		1280
1244	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
1245		1282
1246	=over 4	1283	=over 4
1247		1284
1248	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
1249		1286
1250	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1287	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1251	text in rxvt-unicode's special encoding and an array of rendition values	1288	text in rxvt-unicode's special encoding and an array of rendition values
1252	at a specific position inside the overlay.	1289	at a specific position inside the overlay.
		1290
		1291	If C<$rend> is missing, then the rendition will not be changed.
1253		1292
1254	=item $overlay->hide	1293	=item $overlay->hide
1255		1294
1256	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
1257		1296
…		…
1339	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
1340	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
1341		1380
1342	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
1343		1382
1344	Write the octets given in C<$data> to the tty (i.e. as program input). To	1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1345	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
1346	to the locale-specific encoding using C<< $term->locale_encode >>.	1385	to the locale-specific encoding using C<< $term->locale_encode >>.
		1386
		1387	=item $term->tt_paste ($octets)
		1388
		1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1390	CR and bracketing the data with control sequences if bracketed paste mode
		1391	is set.
1347		1392
1348	=item $old_events = $term->pty_ev_events ([$new_events])	1393	=item $old_events = $term->pty_ev_events ([$new_events])
1349		1394
1350	Replaces the event mask of the pty watcher by the given event mask. Can	1395	Replaces the event mask of the pty watcher by the given event mask. Can
1351	be used to suppress input and output handling to the pty/tty. See the	1396	be used to suppress input and output handling to the pty/tty. See the
…		…
1370	Adds the specified events to the vt event mask. Useful e.g. when you want	1415	Adds the specified events to the vt event mask. Useful e.g. when you want
1371	to receive pointer events all the times:	1416	to receive pointer events all the times:
1372		1417
1373	$term->vt_emask_add (urxvt::PointerMotionMask);	1418	$term->vt_emask_add (urxvt::PointerMotionMask);
1374		1419
		1420	=item $term->set_urgency ($set)
		1421
		1422	Enable/disable the urgency hint on the toplevel window.
		1423
		1424	=item $term->focus_in
		1425
		1426	=item $term->focus_out
		1427
		1428	=item $term->key_press ($state, $keycode[, $time])
		1429
		1430	=item $term->key_release ($state, $keycode[, $time])
		1431
		1432	Deliver various fake events to to terminal.
		1433
1375	=item $window_width = $term->width	1434	=item $window_width = $term->width
1376		1435
1377	=item $window_height = $term->height	1436	=item $window_height = $term->height
1378		1437
1379	=item $font_width = $term->fwidth	1438	=item $font_width = $term->fwidth
…		…
1409	=item $env = $term->env	1468	=item $env = $term->env
1410		1469
1411	Returns a copy of the environment in effect for the terminal as a hashref	1470	Returns a copy of the environment in effect for the terminal as a hashref
1412	similar to C<\%ENV>.	1471	similar to C<\%ENV>.
1413		1472
		1473	=item @envv = $term->envv
		1474
		1475	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1476
		1477	=item @argv = $term->argv
		1478
		1479	Return the argument vector as this terminal, similar to @ARGV, but
		1480	includes the program name as first element.
		1481
1414	=cut	1482	=cut
1415		1483
1416	sub env {	1484	sub env {
1417	if (my $env = $_[0]->_env) {
1418	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1485	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1419	} else {
1420	+{ %ENV }
1421	}
1422	}	1486	}
1423		1487
1424	=item $modifiermask = $term->ModLevel3Mask	1488	=item $modifiermask = $term->ModLevel3Mask
1425		1489
1426	=item $modifiermask = $term->ModMetaMask	1490	=item $modifiermask = $term->ModMetaMask
…		…
1434		1498
1435	Returns the currently displayed screen (0 primary, 1 secondary).	1499	Returns the currently displayed screen (0 primary, 1 secondary).
1436		1500
1437	=item $cursor_is_hidden = $term->hidden_cursor	1501	=item $cursor_is_hidden = $term->hidden_cursor
1438		1502
1439	Returns wether the cursor is currently hidden or not.	1503	Returns whether the cursor is currently hidden or not.
1440		1504
1441	=item $view_start = $term->view_start ([$newvalue])	1505	=item $view_start = $term->view_start ([$newvalue])
1442		1506
1443	Returns the row number of the topmost displayed line. Maximum value is	1507	Returns the row number of the topmost displayed line. Maximum value is
1444	C<0>, which displays the normal terminal contents. Lower values scroll	1508	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1452		1516
1453	Used after changing terminal contents to display them.	1517	Used after changing terminal contents to display them.
1454		1518
1455	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1456		1520
1457	Returns the text of the entire row with number C<$row_number>. Row C<0>	1521	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1458	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1522	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1459	terminal line. The scrollback buffer starts at line C<-1> and extends to
1460	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1523	terminal line. Nothing will be returned if a nonexistent line
1461	is requested.	1524	is requested.
1462		1525
1463	If C<$new_text> is specified, it will replace characters in the current	1526	If C<$new_text> is specified, it will replace characters in the current
1464	line, starting at column C<$start_col> (default C<0>), which is useful	1527	line, starting at column C<$start_col> (default C<0>), which is useful
1465	to replace only parts of a line. The font index in the rendition will	1528	to replace only parts of a line. The font index in the rendition will
1466	automatically be updated.	1529	automatically be updated.
1467		1530
1468	C<$text> is in a special encoding: tabs and wide characters that use more	1531	C<$text> is in a special encoding: tabs and wide characters that use more
1469	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1532	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1470	characters. Characters with combining characters and other characters that	1533	characters. Characters with combining characters and other characters that
1471	do not fit into the normal tetx encoding will be replaced with characters	1534	do not fit into the normal text encoding will be replaced with characters
1472	in the private use area.	1535	in the private use area.
1473		1536
1474	You have to obey this encoding when changing text. The advantage is	1537	You have to obey this encoding when changing text. The advantage is
1475	that C<substr> and similar functions work on screen cells and not on	1538	that C<substr> and similar functions work on screen cells and not on
1476	characters.	1539	characters.
…		…
1621	where one character corresponds to one screen cell. See	1684	where one character corresponds to one screen cell. See
1622	C<< $term->ROW_t >> for details.	1685	C<< $term->ROW_t >> for details.
1623		1686
1624	=item $string = $term->special_decode $text	1687	=item $string = $term->special_decode $text
1625		1688
1626	Converts rxvt-unicodes text reprsentation into a perl string. See	1689	Converts rxvt-unicodes text representation into a perl string. See
1627	C<< $term->ROW_t >> for details.	1690	C<< $term->ROW_t >> for details.
1628		1691
1629	=item $success = $term->grab_button ($button, $modifiermask)	1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1630		1693
		1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1695
1631	Registers a synchronous button grab. See the XGrabButton manpage.	1696	Register/unregister a synchronous button grab. See the XGrabButton
		1697	manpage.
1632		1698
1633	=item $success = $term->grab ($eventtime[, $sync])	1699	=item $success = $term->grab ($eventtime[, $sync])
1634		1700
1635	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1701	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1636	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1702	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1637		1703
1638	=item $term->allow_events_async	1704	=item $term->allow_events_async
1639		1705
1640	Calls XAllowEvents with AsyncBoth for the most recent grab.	1706	Calls XAllowEvents with AsyncBoth for the most recent grab.
1641		1707
…		…
1648	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1649	recent grab.	1715	recent grab.
1650		1716
1651	=item $term->ungrab	1717	=item $term->ungrab
1652		1718
1653	Calls XUngrab for the most recent grab. Is called automatically on	1719	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1654	evaluation errors, as it is better to lose the grab in the error case as	1720	evaluation errors, as it is better to lose the grab in the error case as
1655	the session.	1721	the session.
1656		1722
1657	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1723	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1658		1724
…		…
1660		1726
1661	=item @atoms = $term->XListProperties ($window)	1727	=item @atoms = $term->XListProperties ($window)
1662		1728
1663	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1729	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1664		1730
1665	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1731	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1666		1732
1667	=item $term->XDeleteProperty ($window, $property)	1733	=item $term->XDeleteProperty ($window, $property)
1668		1734
1669	=item $window = $term->DefaultRootWindow	1735	=item $window = $term->DefaultRootWindow
1670		1736
…		…
1677	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1743	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1678		1744
1679	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1745	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1680		1746
1681	=item $term->XChangeInput ($window, $add_events[, $del_events])	1747	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1748
		1749	=item $keysym = $term->XStringToKeysym ($string)
		1750
		1751	=item $string = $term->XKeysymToString ($keysym)
1682		1752
1683	Various X or X-related functions. The C<$term> object only serves as	1753	Various X or X-related functions. The C<$term> object only serves as
1684	the source of the display, otherwise those functions map more-or-less	1754	the source of the display, otherwise those functions map more-or-less
1685	directory onto the X functions of the same name.	1755	directly onto the X functions of the same name.
1686		1756
1687	=back	1757	=back
1688		1758
1689	=cut	1759	=cut
1690		1760
…		…
1754	my ($self, $text, $cb) = @_;	1824	my ($self, $text, $cb) = @_;
1755		1825
1756	$self->add_item ({ type => "button", text => $text, activate => $cb});	1826	$self->add_item ({ type => "button", text => $text, activate => $cb});
1757	}	1827	}
1758		1828
1759	=item $popup->add_toggle ($text, $cb, $initial_value)	1829	=item $popup->add_toggle ($text, $initial_value, $cb)
1760		1830
1761	Adds a toggle/checkbox item to the popup. Teh callback gets called	1831	Adds a toggle/checkbox item to the popup. The callback gets called
1762	whenever it gets toggled, with a boolean indicating its value as its first	1832	whenever it gets toggled, with a boolean indicating its new value as its
1763	argument.	1833	first argument.
1764		1834
1765	=cut	1835	=cut
1766		1836
1767	sub add_toggle {	1837	sub add_toggle {
1768	my ($self, $text, $cb, $value) = @_;	1838	my ($self, $text, $value, $cb) = @_;
1769		1839
1770	my $item; $item = {	1840	my $item; $item = {
1771	type => "button",	1841	type => "button",
1772	text => " $text",	1842	text => " $text",
1773	value => $value,	1843	value => $value,
…		…
1792	my $env = $self->{term}->env;	1862	my $env = $self->{term}->env;
1793	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1863	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1794	delete $env->{LC_ALL};	1864	delete $env->{LC_ALL};
1795	$env->{LC_CTYPE} = $self->{term}->locale;	1865	$env->{LC_CTYPE} = $self->{term}->locale;
1796		1866
1797	urxvt::term->new ($env, "popup",	1867	my $term = urxvt::term->new (
		1868	$env, "popup",
1798	"--perl-lib" => "", "--perl-ext-common" => "",	1869	"--perl-lib" => "", "--perl-ext-common" => "",
1799	"-pty-fd" => -1, "-sl" => 0,	1870	"-pty-fd" => -1, "-sl" => 0,
1800	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1871	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1801	"--transient-for" => $self->{term}->parent,	1872	"--transient-for" => $self->{term}->parent,
1802	"-display" => $self->{term}->display_id,	1873	"-display" => $self->{term}->display_id,
1803	"-pe" => "urxvt-popup")	1874	"-pe" => "urxvt-popup",
1804	or die "unable to create popup window\n";	1875	) or die "unable to create popup window\n";
		1876
		1877	unless (delete $term->{urxvt_popup_init_done}) {
		1878	$term->ungrab;
		1879	$term->destroy;
		1880	die "unable to initialise popup window\n";
		1881	}
1805	}	1882	}
1806		1883
1807	sub DESTROY {	1884	sub DESTROY {
1808	my ($self) = @_;	1885	my ($self) = @_;
1809		1886
…		…
1814	=back	1891	=back
1815		1892
1816	=cut	1893	=cut
1817		1894
1818	package urxvt::watcher;	1895	package urxvt::watcher;
1819
1820	@urxvt::timer::ISA = __PACKAGE__;
1821	@urxvt::iow::ISA = __PACKAGE__;
1822	@urxvt::pw::ISA = __PACKAGE__;
1823	@urxvt::iw::ISA = __PACKAGE__;
1824		1896
1825	=head2 The C<urxvt::timer> Class	1897	=head2 The C<urxvt::timer> Class
1826		1898
1827	This class implements timer watchers/events. Time is represented as a	1899	This class implements timer watchers/events. Time is represented as a
1828	fractional number of seconds since the epoch. Example:	1900	fractional number of seconds since the epoch. Example:
…		…
1832	->new	1904	->new
1833	->interval (1)	1905	->interval (1)
1834	->cb (sub {	1906	->cb (sub {
1835	$term->{overlay}->set (0, 0,	1907	$term->{overlay}->set (0, 0,
1836	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1837	});	1909	});
1838		1910
1839	=over 4	1911	=over 4
1840		1912
1841	=item $timer = new urxvt::timer	1913	=item $timer = new urxvt::timer
1842		1914
…		…
1845		1917
1846	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1847		1919
1848	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
1849		1921
1850	=item $tstamp = $timer->at
1851
1852	Return the time this watcher will fire next.
1853
1854	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
1855		1923
1856	Set the time the event is generated to $tstamp.	1924	Set the time the event is generated to $tstamp (and optionally specifies a
		1925	new $interval).
1857		1926
1858	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
1859		1928
1860	Normally (and when C<$interval> is C<0>), the timer will automatically	1929	By default (and when C<$interval> is C<0>), the timer will automatically
1861	stop after it has fired once. If C<$interval> is non-zero, then the timer	1930	stop after it has fired once. If C<$interval> is non-zero, then the timer
1862	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
1863		1932
1864	=item $timer = $timer->start	1933	=item $timer = $timer->start
1865		1934
1866	Start the timer.	1935	Start the timer.
1867		1936
1868	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
1869		1938
1870	Set the event trigger time to C<$tstamp> and start the timer.	1939	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		1940	also replaces the interval.
1871		1941
1872	=item $timer = $timer->after ($delay)	1942	=item $timer = $timer->after ($delay[, $interval])
1873		1943
1874	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	1944	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1875		1945
1876	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
1877		1947
…		…
1885		1955
1886	$term->{socket} = ...	1956	$term->{socket} = ...
1887	$term->{iow} = urxvt::iow	1957	$term->{iow} = urxvt::iow
1888	->new	1958	->new
1889	->fd (fileno $term->{socket})	1959	->fd (fileno $term->{socket})
1890	->events (urxvt::EVENT_READ)	1960	->events (urxvt::EV_READ)
1891	->start	1961	->start
1892	->cb (sub {	1962	->cb (sub {
1893	my ($iow, $revents) = @_;	1963	my ($iow, $revents) = @_;
1894	# $revents must be 1 here, no need to check	1964	# $revents must be 1 here, no need to check
1895	sysread $term->{socket}, my $buf, 8192	1965	sysread $term->{socket}, my $buf, 8192
…		…
1908	Set the callback to be called when io events are triggered. C<$reventmask>	1978	Set the callback to be called when io events are triggered. C<$reventmask>
1909	is a bitset as described in the C<events> method.	1979	is a bitset as described in the C<events> method.
1910		1980
1911	=item $iow = $iow->fd ($fd)	1981	=item $iow = $iow->fd ($fd)
1912		1982
1913	Set the filedescriptor (not handle) to watch.	1983	Set the file descriptor (not handle) to watch.
1914		1984
1915	=item $iow = $iow->events ($eventmask)	1985	=item $iow = $iow->events ($eventmask)
1916		1986
1917	Set the event mask to watch. The only allowed values are	1987	Set the event mask to watch. The only allowed values are
1918	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	1988	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1919	together, or C<urxvt::EVENT_NONE>.	1989	together, or C<urxvt::EV_NONE>.
1920		1990
1921	=item $iow = $iow->start	1991	=item $iow = $iow->start
1922		1992
1923	Start watching for requested events on the given handle.	1993	Start watching for requested events on the given handle.
1924		1994
1925	=item $iow = $iow->stop	1995	=item $iow = $iow->stop
1926		1996
1927	Stop watching for events on the given filehandle.	1997	Stop watching for events on the given file handle.
1928		1998
1929	=back	1999	=back
1930		2000
1931	=head2 The C<urxvt::iw> Class	2001	=head2 The C<urxvt::iw> Class
1932		2002
…		…
1965	->new	2035	->new
1966	->start ($pid)	2036	->start ($pid)
1967	->cb (sub {	2037	->cb (sub {
1968	my ($pw, $exit_status) = @_;	2038	my ($pw, $exit_status) = @_;
1969	...	2039	...
1970	});	2040	});
1971		2041
1972	=over 4	2042	=over 4
1973		2043
1974	=item $pw = new urxvt::pw	2044	=item $pw = new urxvt::pw
1975		2045
…		…
1979		2049
1980	Set the callback to be called when the timer triggers.	2050	Set the callback to be called when the timer triggers.
1981		2051
1982	=item $pw = $timer->start ($pid)	2052	=item $pw = $timer->start ($pid)
1983		2053
1984	Tells the wqtcher to start watching for process C<$pid>.	2054	Tells the watcher to start watching for process C<$pid>.
1985		2055
1986	=item $pw = $pw->stop	2056	=item $pw = $pw->stop
1987		2057
1988	Stop the watcher.	2058	Stop the watcher.
1989		2059
…		…
2002		2072
2003	=item >= 3 - script loading and management	2073	=item >= 3 - script loading and management
2004		2074
2005	=item >=10 - all called hooks	2075	=item >=10 - all called hooks
2006		2076
2007	=item >=11 - hook reutrn values	2077	=item >=11 - hook return values
2008		2078
2009	=back	2079	=back
2010		2080
2011	=head1 AUTHOR	2081	=head1 AUTHOR
2012		2082
2013	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
2014	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
2015		2085
2016	=cut	2086	=cut
2017		2087
2018	1	2088	1
		2089
		2090	# vim: sw=3:

Diff Legend

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