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.133 by root, Mon Feb 6 06:14:08 2006 UTC vs.
Revision 1.219 by sf-exg, Sun Jun 10 18:23: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	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.
102
103	It's sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as
107	first argument.
108
109	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:
111
112	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};
115
116	=item selection-popup (enabled by default)
117
118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119	text into various other formats/action (such as uri unescaping, perl
120	evaluation, web-browser starting etc.), depending on content.
121
122	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.
125
126	It's sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide wether to add something or not.
128	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.
131
132	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:
135
136	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }
138	: ()
139	};
140
141	=item searchable-scrollback<hotkey> (enabled by default)
142
143	Adds regex search functionality to the scrollback buffer, triggered
144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
145	input/output is suspended and a regex is displayed at the bottom of the
146	screen.
147
148	Inputting characters appends them to the regex and continues incremental
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary
154	selection.
155
156	=item readline (enabled by default)
157
158	A support package that tries to make editing with readline easier. At the
159	moment, it reacts to clicking with the left mouse button by trying to
160	move the text cursor to this position. It does so by generating as many
161	cursor-left or cursor-right keypresses as required (the this only works
162	for programs that correctly support wide characters).
163
164	To avoid too many false positives, this is only done when:
165
166	=over 4
167
168	=item - the tty is in ICANON state.
169
170	=item - the text cursor is visible.
171
172	=item - the primary screen is currently being displayed.
173
174	=item - the mouse is on the same (multi-row-) line as the text cursor.
175
176	=back
177
178	The normal selection mechanism isn't disabled, so quick successive clicks
179	might interfere with selection creation in harmless ways.
180
181	=item selection-autotransform
182
183	This selection allows you to do automatic transforms on a selection
184	whenever a selection is made.
185
186	It works by specifying perl snippets (most useful is a single C<s///>
187	operator) that modify C<$_> as resources:
188
189	URxvt.selection-autotransform.0: transform
190	URxvt.selection-autotransform.1: transform
191	...
192
193	For example, the following will transform selections of the form
194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
195	$word>:
196
197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
198
199	And this example matches the same,but replaces it with vi-commands you can
200	paste directly into your (vi :) editor:
201
202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
203
204	Of course, this can be modified to suit your needs and your editor :)
205
206	To expand the example above to typical perl error messages ("XXX at
207	FILENAME line YYY."), you need a slightly more elaborate solution:
208
209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
211
212	The first line tells the selection code to treat the unchanging part of
213	every error message as a selection pattern, and the second line transforms
214	the message into vi commands to load the file.
215
216	=item tabbed
217
218	This transforms the terminal into a tabbar with additional terminals, that
219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
221	button per tab.
222
223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
224	B<Shift-Right> will switch to the tab left or right of the current one,
225	while B<Shift-Down> creates a new tab.
226
227	The tabbar itself can be configured similarly to a normal terminal, but
228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
229	following four resources (shown with defaults):
230
231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
233	URxvt.tabbed.tab-fg: <colour-index, default 0>
234	URxvt.tabbed.tab-bg: <colour-index, default 1>
235
236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237	indices.
238
239	=item mark-urls
240
241	Uses per-line display filtering (C<on_line_update>) to underline urls and
242	make them clickable. When middle-clicked, the program specified in the
243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
244	the URL as first argument.
245
246	=item xim-onthespot
247
248	This (experimental) perl extension implements OnTheSpot editing. It does
249	not work perfectly, and some input methods don't seem to work well with
250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
251	kinput2.
252
253	You enable it by specifying this extension and a preedit style of
254	C<OnTheSpot>, i.e.:
255
256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257
258	=item automove-background
259
260	This is basically a one-line extension that dynamically changes the background pixmap offset
261	to the window position, in effect creating the same effect as pseudo transparency with
262	a custom pixmap. No scaling is supported in this mode. Exmaple:
263
264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
265
266	=item block-graphics-to-ascii
267
268	A not very useful example of filtering all text output to the terminal,
269	by replacing all line-drawing characters (U+2500 .. U+259F) by a
270	similar-looking ascii character.
271
272	=item digital-clock
273
274	Displays a digital clock using the built-in overlay.
275
276	=item remote-clipboard
277
278	Somewhat of a misnomer, this extension adds two menu entries to the
279	selection popup that allows one ti run external commands to store the
280	selection somewhere and fetch it again.
281
282	We use it to implement a "distributed selection mechanism", which just
283	means that one command uploads the file to a remote server, and another
284	reads it.
285
286	The commands can be set using the C<URxvt.remote-selection.store> and
287	C<URxvt.remote-selection.fetch> resources. The first should read the
288	selection to store from STDIN (always in UTF-8), the second should provide
289	the selection data on STDOUT (also in UTF-8).
290
291	The defaults (which are likely useless to you) use rsh and cat:
292
293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
295
296	=item selection-pastebin
297
298	This is a little rarely useful extension that Uploads the selection as
299	textfile to a remote site (or does other things). (The implementation is
300	not currently secure for use in a multiuser environment as it writes to
301	F</tmp> directly.).
302
303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
304	i.e.
305
306	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
307
308	Pressing this combination runs a command with C<%> replaced by the name of
309	the textfile. This command can be set via a resource:
310
311	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
312
313	And the default is likely not useful to anybody but the few people around
314	here :)
315
316	The name of the textfile is the hex encoded md5 sum of the selection, so
317	the same content should lead to the same filename.
318
319	After a successful upload the selection will be replaced by the text given
320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
321	for the filename):
322
323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324
325	=item example-refresh-hooks
326
327	Displays a very simple digital clock in the upper right corner of the
328	window. Illustrates overwriting the refresh callbacks to create your own
329	overlays or changes.
330
331	=back
332		50
333	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
334		52
335	=head2 General API Considerations	53	=head2 General API Considerations
336		54
…		…
350		68
351	=over 4	69	=over 4
352		70
353	=item $text	71	=item $text
354		72
355	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
356	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.
357		75
358	=item $string	76	=item $string
359		77
360	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
…		…
364	=item $octets	82	=item $octets
365		83
366	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
367	locale-specific way.	85	locale-specific way.
368		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
369	=back	93	=back
370		94
371	=head2 Extension Objects	95	=head2 Extension Objects
372		96
373	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
374	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,
375	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
376	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
377	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
378	use.	103	internal use.
379		104
380	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
381	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
382		107
383	It has the following methods and data members:	108	It has the following methods and data members:
…		…
404	=head2 Hooks	129	=head2 Hooks
405		130
406	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
407	called whenever the relevant event happens.	132	called whenever the relevant event happens.
408		133
409	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
410	the in the C<Extension Objects> section.	135	the in the C<Extension Objects> section.
411		136
412	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
413	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
414	relevant action might not be carried out by the C++ code.	139	relevant action might not be carried out by the C++ code.
…		…
427	place.	152	place.
428		153
429	=item on_start $term	154	=item on_start $term
430		155
431	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
432	trying to map (display) the toplevel and returning to the mainloop.	157	trying to map (display) the toplevel and returning to the main loop.
433		158
434	=item on_destroy $term	159	=item on_destroy $term
435		160
436	Called whenever something tries to destroy terminal, when the terminal is	161	Called whenever something tries to destroy terminal, when the terminal is
437	still fully functional (not for long, though).	162	still fully functional (not for long, though).
…		…
464		189
465	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
466	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
467	by calling C<< $term->selection >>.	192	by calling C<< $term->selection >>.
468		193
469	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.
470		195
471	=item on_sel_extend $term	196	=item on_sel_extend $term
472		197
473	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
474	click) and is either supposed to return false (normal operation), or	199	click) and is either supposed to return false (normal operation), or
475	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
476	processing. This can happen multiple times, as long as the callback	201	processing. This can happen multiple times, as long as the callback
477	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
478	supposed to enlarge the selection more and more, if possible.	203	supposed to enlarge the selection more and more, if possible.
479		204
480	See the F<selection> example extension.	205	See the F<selection> example extension.
481		206
482	=item on_view_change $term, $offset	207	=item on_view_change $term, $offset
483		208
484	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
485	scrolls. Offset C<0> means display the normal terminal, positive values	210	scrolls. Offset C<0> means display the normal terminal, positive values
486	show this many lines of scrollback.	211	show this many lines of scrollback.
487		212
488	=item on_scroll_back $term, $lines, $saved	213	=item on_scroll_back $term, $lines, $saved
489		214
…		…
493		218
494	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,
495	$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
496	number of lines that will be in the scrollback buffer.	221	number of lines that will be in the scrollback buffer.
497		222
498	=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
499		234
500	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
501	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
502	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
503	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,
504	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
505	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	}
506		251
507	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,
508	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
509	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.
510		258
511	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
512		260
513	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
514	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
…		…
519	=item on_tt_write $term, $octets	267	=item on_tt_write $term, $octets
520		268
521	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
522	suppress or filter tty input.	270	suppress or filter tty input.
523		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
524	=item on_line_update $term, $row	279	=item on_line_update $term, $row
525		280
526	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
527	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
528	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,
…		…
535	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
536	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
537		292
538	=item on_refresh_begin $term	293	=item on_refresh_begin $term
539		294
540	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
541	or similar effects by modify terminal contents in refresh_begin, and	296	similar effects by modifying the terminal contents in refresh_begin, and
542	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
543	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
544		299
545	=item on_refresh_end $term	300	=item on_refresh_end $term
546		301
547	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>.
548		303
549	=item on_user_command $term, $string	304	=item on_user_command $term, $string
550		305
551	Called whenever the a user-configured event is being activated (e.g. via	306	Called whenever a user-configured event is being activated (e.g. via
552	a C<perl:string> action bound to a key, see description of the B<keysym>	307	a C<perl:string> action bound to a key, see description of the B<keysym>
553	resource in the @@RXVT_NAME@@(1) manpage).	308	resource in the @@RXVT_NAME@@(1) manpage).
554		309
555	The event is simply the action string. This interface is assumed to change	310	The event is simply the action string. This interface is assumed to change
556	slightly in the future.	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.
557		325
558	=item on_x_event $term, $event	326	=item on_x_event $term, $event
559		327
560	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
561	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
562	members are not passed.	330	members are not passed.
563		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
564	=item on_focus_in $term	336	=item on_focus_in $term
565		337
566	Called whenever the window gets the keyboard focus, before rxvt-unicode	338	Called whenever the window gets the keyboard focus, before rxvt-unicode
567	does focus in processing.	339	does focus in processing.
568		340
569	=item on_focus_out $term	341	=item on_focus_out $term
570		342
571	Called wheneever the window loses keyboard focus, before rxvt-unicode does	343	Called whenever the window loses keyboard focus, before rxvt-unicode does
572	focus out processing.	344	focus out processing.
573		345
574	=item on_configure_notify $term, $event	346	=item on_configure_notify $term, $event
575		347
576	=item on_property_notify $term, $event	348	=item on_property_notify $term, $event
…		…
587		359
588	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
589		361
590	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
591		363
592	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
593	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.
594		366
595	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
596	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
597	(real, not screen-based) row and column under the mouse cursor.	369	(real, not screen-based) row and column under the mouse cursor.
598		370
…		…
608	=item on_wm_delete_window $term, $event	380	=item on_wm_delete_window $term, $event
609		381
610	Called when various types of ClientMessage events are received (all with	382	Called when various types of ClientMessage events are received (all with
611	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	383	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
612		384
		385	=item on_bell $term
		386
		387	Called on receipt of a bell character.
		388
613	=back	389	=back
614		390
615	=cut	391	=cut
616		392
617	package urxvt;	393	package urxvt;
618		394
619	use utf8;	395	use utf8;
620	use strict;	396	use strict 'vars';
621	use Carp ();	397	use Carp ();
622	use Scalar::Util ();	398	use Scalar::Util ();
623	use List::Util ();	399	use List::Util ();
624		400
625	our $VERSION = 1;	401	our $VERSION = 1;
626	our $TERM;	402	our $TERM;
627	our @TERM_INIT;	403	our @TERM_INIT; # should go, prevents async I/O etc.
628	our @TERM_EXT;	404	our @TERM_EXT; # should go, prevents async I/O etc.
629	our @HOOKNAME;	405	our @HOOKNAME;
630	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
631	our %OPTION;	407	our %OPTION;
632		408
633	our $LIBDIR;	409	our $LIBDIR;
…		…
659	The current terminal. This variable stores the current C<urxvt::term>	435	The current terminal. This variable stores the current C<urxvt::term>
660	object, whenever a callback/hook is executing.	436	object, whenever a callback/hook is executing.
661		437
662	=item @urxvt::TERM_INIT	438	=item @urxvt::TERM_INIT
663		439
664	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
665	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
666	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,
667	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.
668		444
669	This complements to the perl-eval commandline option, but gets executed	445	This complements to the perl-eval command line option, but gets executed
670	first.	446	first.
671		447
672	=item @urxvt::TERM_EXT	448	=item @urxvt::TERM_EXT
673		449
674	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
…		…
681		457
682	=over 4	458	=over 4
683		459
684	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
685		461
686	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
687	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
688	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
689		466
690	=item urxvt::warn $string	467	=item urxvt::warn $string
691		468
692	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
693	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
694	that calls this function.	471	that calls this function.
695		472
696	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
697	correct place, e.g. on stderr of the connecting urxvtc client.	474	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
699	Messages have a size limit of 1023 bytes currently.	476	Messages have a size limit of 1023 bytes currently.
700		477
701	=item @terms = urxvt::termlist	478	=item @terms = urxvt::termlist
702		479
703	Returns all urxvt::term objects that exist in this process, regardless of	480	Returns all urxvt::term objects that exist in this process, regardless of
704	wether they are started, being destroyed etc., so be careful. Only term	481	whether they are started, being destroyed etc., so be careful. Only term
705	objects that have perl extensions attached will be returned (because there	482	objects that have perl extensions attached will be returned (because there
706	is no urxvt::term objet associated with others).	483	is no urxvt::term object associated with others).
707		484
708	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
709		486
710	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
711		488
…		…
754		531
755	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
756		533
757	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
758		535
759	=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
760		538
761	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
762	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
763	the bitset.	541	the bitset.
764		542
…		…
801	};	579	};
802	}	580	}
803		581
804	no warnings 'utf8';	582	no warnings 'utf8';
805		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
806	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
807		645
808	sub verbose {	646	sub verbose {
809	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
810	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
…		…
822	$pkg =~ s/[^[:word:]]/_/g;	660	$pkg =~ s/[^[:word:]]/_/g;
823	$pkg = "urxvt::ext::$pkg";	661	$pkg = "urxvt::ext::$pkg";
824		662
825	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
826		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		666
827	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
828	or die "$path: $!";	668	or die "$path: $!";
829		669
830	my $source =	670	my $source =
831	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
832	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
833	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
834	. "\n};\n1";	674	. "\n};\n1";
835		675
836	eval $source	676	eval $source
…		…
846	sub invoke {	686	sub invoke {
847	local $TERM = shift;	687	local $TERM = shift;
848	my $htype = shift;	688	my $htype = shift;
849		689
850	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
851	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
852		692
853	my %ext_arg;	693	my %ext_arg;
854		694
855	{	695	{
856	my @init = @TERM_INIT;	696	my @init = @TERM_INIT;
857	@TERM_INIT = ();	697	@TERM_INIT = ();
…		…
859	my @pkg = @TERM_EXT;	699	my @pkg = @TERM_EXT;
860	@TERM_EXT = ();	700	@TERM_EXT = ();
861	$TERM->register_package ($_) for @pkg;	701	$TERM->register_package ($_) for @pkg;
862	}	702	}
863		703
		704	for (
		705	@{ delete $TERM->{perl_ext_3} },
864	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
865	if ($_ eq "default") {	708	if ($_ eq "default") {
866	$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);
867	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
868	delete $ext_arg{$1};	711	delete $ext_arg{$1};
869	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
…		…
891		734
892	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
893	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
894	if $verbosity >= 10;	737	if $verbosity >= 10;
895		738
896	keys %$cb;	739	for my $pkg (keys %$cb) {
897
898	while (my ($pkg, $cb) = each %$cb) {
899	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
900	$retval ||= $retval_;	741	$retval ||= $retval_;
901		742
902	if ($@) {	743	if ($@) {
903	$TERM->ungrab; # better to lose the grab than the session	744	$TERM->ungrab; # better to lose the grab than the session
904	warn $@;	745	warn $@;
…		…
922		763
923	sub SET_COLOR($$$) {	764	sub SET_COLOR($$$) {
924	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	765	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
925	}	766	}
926		767
927	# urxvt::term::extension	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	}
928		792
929	package urxvt::term::extension;	793	package urxvt::term::extension;
930		794
931	sub enable {	795	sub enable {
932	my ($self, %hook) = @_;	796	my ($self, %hook) = @_;
…		…
987		851
988	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
989	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
990	}	854	}
991		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
992	package urxvt::anyevent;	868	package urxvt::anyevent;
993		869
994	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
995		871
996	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
997	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
998	further programming. The only exception is that you cannot wait on	874	further programming. The only exception is that you cannot wait on
999	condition variables, but non-blocking condvar use is ok. What this means	875	condition variables, but non-blocking condvar use is ok.
1000	is that you cannot use blocking APIs, but the non-blocking variant should	876
1001	work.	877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
1002		879
1003	=cut	880	=cut
1004		881
1005	our $VERSION = 1;	882	our $VERSION = '5.23';
1006		883
1007	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1008	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1009		886
1010	sub timer {	887	sub timer {
…		…
1012		889
1013	my $cb = $arg{cb};	890	my $cb = $arg{cb};
1014		891
1015	urxvt::timer	892	urxvt::timer
1016	->new	893	->new
1017	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
1018	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
1019	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
1020	$cb->();	897	$cb->();
1021	})	898	})
1022	}	899	}
1023		900
1024	sub io {	901	sub io {
1025	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
1026		903
1027	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
1028		907
1029	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
1030	->new	909	->new
1031	->fd (fileno $arg{fh})	910	->fd ($fd)
1032	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
1033	| ($arg{poll} =~ /w/ ? 2 : 0))	912	| ($arg{poll} =~ /w/ ? 2 : 0))
1034	->start	913	->start
1035	->cb (sub {	914	->cb ($cb)
1036	$cb->(($_[1] & 1 ? 'r' : '')
1037	. ($_[1] & 2 ? 'w' : ''));
1038	})],
1039	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	})
1040	}	941	}
1041		942
1042	sub DESTROY {	943	sub DESTROY {
1043	$_[0][1]->stop;	944	$_[0][1]->stop;
1044	}	945	}
1045		946
1046	sub condvar {	947	# only needed for AnyEvent < 6 compatibility
1047	bless \my $flag, urxvt::anyevent::condvar::	948	sub one_event {
1048	}
1049
1050	sub urxvt::anyevent::condvar::broadcast {
1051	${$_[0]}++;
1052	}
1053
1054	sub urxvt::anyevent::condvar::wait {
1055	unless (${$_[0]}) {
1056	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";
1057	}
1058	}	950	}
1059		951
1060	package urxvt::term;	952	package urxvt::term;
1061		953
1062	=head2 The C<urxvt::term> Class	954	=head2 The C<urxvt::term> Class
…		…
1075	urxvt::verbose 6, "register package $pkg to $self";	967	urxvt::verbose 6, "register package $pkg to $self";
1076		968
1077	@{"$pkg\::ISA"} = urxvt::term::extension::;	969	@{"$pkg\::ISA"} = urxvt::term::extension::;
1078		970
1079	my $proxy = bless {	971	my $proxy = bless {
1080	_pkg => $pkg,	972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
1081	argv => $argv,	974	argv => $argv,
1082	}, $pkg;	975	}, $pkg;
1083	Scalar::Util::weaken ($proxy->{term} = $self);	976	Scalar::Util::weaken ($proxy->{term} = $self);
1084		977
1085	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
1086		979
…		…
1089	$proxy->enable ($name => $ref);	982	$proxy->enable ($name => $ref);
1090	}	983	}
1091	}	984	}
1092	}	985	}
1093		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
1094	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1095		1035
1096	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
1097	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
1098	hash which defines the environment of the new terminal.	1038	hash which defines the environment of the new terminal.
…		…
1149		1089
1150	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
1151	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
1152	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.
1153		1093
1154	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
1155	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
1156		1096
1157	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
1158	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1159	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1160	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1161	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1162	transparent tripleclickwords utmpInhibit visualBell	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1103	urgentOnBell utmpInhibit visualBell
1163		1104
1164	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
1165		1106
1166	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
1167	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>
…		…
1176	likely change).	1117	likely change).
1177		1118
1178	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
1179	terminal is destroyed, so changing options frequently will eat memory.	1120	terminal is destroyed, so changing options frequently will eat memory.
1180		1121
1181	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
1182	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>
1183	to see the actual list:	1124	to see the actual list:
1184		1125
1185	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blurradius
1186	borderLess color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1187	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1188	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
1189	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1190	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1191	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1192	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1193	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1194	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1195	secondaryScreen secondaryScroll selectstyle shade term_name title	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1196	transient_for transparent transparent_all tripleclickwords utmpInhibit	1138	term_name title transient_for transparent tripleclickwords urgentOnBell
1197	visualBell	1139	utmpInhibit visualBell
1198		1140
1199	=cut	1141	=cut
1200		1142
1201	sub resource($$;$) {	1143	sub resource($$;$) {
1202	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
1203	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1145	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1204	&urxvt::term::_resource	1146	goto &urxvt::term::_resource
1205	}	1147	}
1206		1148
1207	=item $value = $term->x_resource ($pattern)	1149	=item $value = $term->x_resource ($pattern)
1208		1150
1209	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
1210	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
1211	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
1212	resource with that pattern exists.	1154	resource with that pattern exists.
1213		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 replaced 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
1214	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
1215	only one resource database per display, and later invocations might return	1167	only one resource database per display, and later invocations might return
1216	the wrong resources.	1168	the wrong resources.
1217		1169
1218	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1170	=item $value = $term->x_resource_boolean ($pattern)
1219		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
1220	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
1221	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.
1222		1197
1223	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
1224		1199
1225	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
1226	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
1234		1209
1235	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
1236		1211
1237	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
1238		1213
1239	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.
1240	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.
1241		1223
1242	=item $term->selection_make ($eventtime[, $rectangular])	1224	=item $term->selection_make ($eventtime[, $rectangular])
1243		1225
1244	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
1245	C<selection_end>. If C<$rectangular> is true (default: false), a	1227	C<selection_end>. If C<$rectangular> is true (default: false), a
1246	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
1247	a selection.	1229	a selection.
1248		1230
1249	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1250		1232
1251	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
1252	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
1253	is mostly useful from within C<on_sel_grab> hooks.	1236	is mostly useful from within C<on_sel_grab> hooks.
1254		1237
1255	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
1256		1239
1257	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.
1258		1246
1259	=item $term->overlay_simple ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
1260		1248
1261	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.
1262		1250
…		…
1292		1280
1293	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
1294		1282
1295	=over 4	1283	=over 4
1296		1284
1297	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
1298		1286
1299	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
1300	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
1301	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.
1302		1292
1303	=item $overlay->hide	1293	=item $overlay->hide
1304		1294
1305	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
1306		1296
…		…
1388	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
1389	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
1390		1380
1391	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
1392		1382
1393	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
1394	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
1395	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.
1396		1392
1397	=item $old_events = $term->pty_ev_events ([$new_events])	1393	=item $old_events = $term->pty_ev_events ([$new_events])
1398		1394
1399	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
1400	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
…		…
1419	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
1420	to receive pointer events all the times:	1416	to receive pointer events all the times:
1421		1417
1422	$term->vt_emask_add (urxvt::PointerMotionMask);	1418	$term->vt_emask_add (urxvt::PointerMotionMask);
1423		1419
		1420	=item $term->set_urgency ($set)
		1421
		1422	Enable/disable the urgency hint on the toplevel window.
		1423
1424	=item $term->focus_in	1424	=item $term->focus_in
1425		1425
1426	=item $term->focus_out	1426	=item $term->focus_out
1427		1427
1428	=item $term->key_press ($state, $keycode[, $time])	1428	=item $term->key_press ($state, $keycode[, $time])
…		…
1468	=item $env = $term->env	1468	=item $env = $term->env
1469		1469
1470	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
1471	similar to C<\%ENV>.	1471	similar to C<\%ENV>.
1472		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
1473	=cut	1482	=cut
1474		1483
1475	sub env {	1484	sub env {
1476	if (my $env = $_[0]->_env) {
1477	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1485	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1478	} else {
1479	+{ %ENV }
1480	}
1481	}	1486	}
1482		1487
1483	=item $modifiermask = $term->ModLevel3Mask	1488	=item $modifiermask = $term->ModLevel3Mask
1484		1489
1485	=item $modifiermask = $term->ModMetaMask	1490	=item $modifiermask = $term->ModMetaMask
…		…
1493		1498
1494	Returns the currently displayed screen (0 primary, 1 secondary).	1499	Returns the currently displayed screen (0 primary, 1 secondary).
1495		1500
1496	=item $cursor_is_hidden = $term->hidden_cursor	1501	=item $cursor_is_hidden = $term->hidden_cursor
1497		1502
1498	Returns wether the cursor is currently hidden or not.	1503	Returns whether the cursor is currently hidden or not.
1499		1504
1500	=item $view_start = $term->view_start ([$newvalue])	1505	=item $view_start = $term->view_start ([$newvalue])
1501		1506
1502	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
1503	C<0>, which displays the normal terminal contents. Lower values scroll	1508	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1511		1516
1512	Used after changing terminal contents to display them.	1517	Used after changing terminal contents to display them.
1513		1518
1514	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1515		1520
1516	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 >>
1517	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
1518	terminal line. The scrollback buffer starts at line C<-1> and extends to
1519	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1523	terminal line. Nothing will be returned if a nonexistent line
1520	is requested.	1524	is requested.
1521		1525
1522	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
1523	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
1524	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
1525	automatically be updated.	1529	automatically be updated.
1526		1530
1527	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
1528	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)
1529	characters. Characters with combining characters and other characters that	1533	characters. Characters with combining characters and other characters that
1530	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
1531	in the private use area.	1535	in the private use area.
1532		1536
1533	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
1534	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
1535	characters.	1539	characters.
…		…
1680	where one character corresponds to one screen cell. See	1684	where one character corresponds to one screen cell. See
1681	C<< $term->ROW_t >> for details.	1685	C<< $term->ROW_t >> for details.
1682		1686
1683	=item $string = $term->special_decode $text	1687	=item $string = $term->special_decode $text
1684		1688
1685	Converts rxvt-unicodes text reprsentation into a perl string. See	1689	Converts rxvt-unicodes text representation into a perl string. See
1686	C<< $term->ROW_t >> for details.	1690	C<< $term->ROW_t >> for details.
1687		1691
1688	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1689		1693
1690	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1693	manpage.	1697	manpage.
1694		1698
1695	=item $success = $term->grab ($eventtime[, $sync])	1699	=item $success = $term->grab ($eventtime[, $sync])
1696		1700
1697	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1701	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1698	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1702	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1699		1703
1700	=item $term->allow_events_async	1704	=item $term->allow_events_async
1701		1705
1702	Calls XAllowEvents with AsyncBoth for the most recent grab.	1706	Calls XAllowEvents with AsyncBoth for the most recent grab.
1703		1707
…		…
1710	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1711	recent grab.	1715	recent grab.
1712		1716
1713	=item $term->ungrab	1717	=item $term->ungrab
1714		1718
1715	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
1716	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
1717	the session.	1721	the session.
1718		1722
1719	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1723	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1720		1724
…		…
1722		1726
1723	=item @atoms = $term->XListProperties ($window)	1727	=item @atoms = $term->XListProperties ($window)
1724		1728
1725	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1729	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1726		1730
1727	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1731	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1728		1732
1729	=item $term->XDeleteProperty ($window, $property)	1733	=item $term->XDeleteProperty ($window, $property)
1730		1734
1731	=item $window = $term->DefaultRootWindow	1735	=item $window = $term->DefaultRootWindow
1732		1736
…		…
1739	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1743	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1740		1744
1741	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1745	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1742		1746
1743	=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)
1744		1752
1745	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
1746	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
1747	directory onto the X functions of the same name.	1755	directly onto the X functions of the same name.
1748		1756
1749	=back	1757	=back
1750		1758
1751	=cut	1759	=cut
1752		1760
…		…
1854	my $env = $self->{term}->env;	1862	my $env = $self->{term}->env;
1855	# 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.
1856	delete $env->{LC_ALL};	1864	delete $env->{LC_ALL};
1857	$env->{LC_CTYPE} = $self->{term}->locale;	1865	$env->{LC_CTYPE} = $self->{term}->locale;
1858		1866
1859	urxvt::term->new ($env, "popup",	1867	my $term = urxvt::term->new (
		1868	$env, "popup",
1860	"--perl-lib" => "", "--perl-ext-common" => "",	1869	"--perl-lib" => "", "--perl-ext-common" => "",
1861	"-pty-fd" => -1, "-sl" => 0,	1870	"-pty-fd" => -1, "-sl" => 0,
1862	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1871	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1863	"--transient-for" => $self->{term}->parent,	1872	"--transient-for" => $self->{term}->parent,
1864	"-display" => $self->{term}->display_id,	1873	"-display" => $self->{term}->display_id,
1865	"-pe" => "urxvt-popup")	1874	"-pe" => "urxvt-popup",
1866	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	}
1867	}	1882	}
1868		1883
1869	sub DESTROY {	1884	sub DESTROY {
1870	my ($self) = @_;	1885	my ($self) = @_;
1871		1886
…		…
1876	=back	1891	=back
1877		1892
1878	=cut	1893	=cut
1879		1894
1880	package urxvt::watcher;	1895	package urxvt::watcher;
1881
1882	@urxvt::timer::ISA = __PACKAGE__;
1883	@urxvt::iow::ISA = __PACKAGE__;
1884	@urxvt::pw::ISA = __PACKAGE__;
1885	@urxvt::iw::ISA = __PACKAGE__;
1886		1896
1887	=head2 The C<urxvt::timer> Class	1897	=head2 The C<urxvt::timer> Class
1888		1898
1889	This class implements timer watchers/events. Time is represented as a	1899	This class implements timer watchers/events. Time is represented as a
1890	fractional number of seconds since the epoch. Example:	1900	fractional number of seconds since the epoch. Example:
…		…
1894	->new	1904	->new
1895	->interval (1)	1905	->interval (1)
1896	->cb (sub {	1906	->cb (sub {
1897	$term->{overlay}->set (0, 0,	1907	$term->{overlay}->set (0, 0,
1898	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1899	});	1909	});
1900		1910
1901	=over 4	1911	=over 4
1902		1912
1903	=item $timer = new urxvt::timer	1913	=item $timer = new urxvt::timer
1904		1914
…		…
1907		1917
1908	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1909		1919
1910	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
1911		1921
1912	=item $tstamp = $timer->at
1913
1914	Return the time this watcher will fire next.
1915
1916	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
1917		1923
1918	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).
1919		1926
1920	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
1921		1928
1922	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
1923	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
1924	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
1925		1932
1926	=item $timer = $timer->start	1933	=item $timer = $timer->start
1927		1934
1928	Start the timer.	1935	Start the timer.
1929		1936
1930	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
1931		1938
1932	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.
1933		1941
1934	=item $timer = $timer->after ($delay)	1942	=item $timer = $timer->after ($delay[, $interval])
1935		1943
1936	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>.
1937		1945
1938	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
1939		1947
…		…
1947		1955
1948	$term->{socket} = ...	1956	$term->{socket} = ...
1949	$term->{iow} = urxvt::iow	1957	$term->{iow} = urxvt::iow
1950	->new	1958	->new
1951	->fd (fileno $term->{socket})	1959	->fd (fileno $term->{socket})
1952	->events (urxvt::EVENT_READ)	1960	->events (urxvt::EV_READ)
1953	->start	1961	->start
1954	->cb (sub {	1962	->cb (sub {
1955	my ($iow, $revents) = @_;	1963	my ($iow, $revents) = @_;
1956	# $revents must be 1 here, no need to check	1964	# $revents must be 1 here, no need to check
1957	sysread $term->{socket}, my $buf, 8192	1965	sysread $term->{socket}, my $buf, 8192
…		…
1970	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>
1971	is a bitset as described in the C<events> method.	1979	is a bitset as described in the C<events> method.
1972		1980
1973	=item $iow = $iow->fd ($fd)	1981	=item $iow = $iow->fd ($fd)
1974		1982
1975	Set the filedescriptor (not handle) to watch.	1983	Set the file descriptor (not handle) to watch.
1976		1984
1977	=item $iow = $iow->events ($eventmask)	1985	=item $iow = $iow->events ($eventmask)
1978		1986
1979	Set the event mask to watch. The only allowed values are	1987	Set the event mask to watch. The only allowed values are
1980	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
1981	together, or C<urxvt::EVENT_NONE>.	1989	together, or C<urxvt::EV_NONE>.
1982		1990
1983	=item $iow = $iow->start	1991	=item $iow = $iow->start
1984		1992
1985	Start watching for requested events on the given handle.	1993	Start watching for requested events on the given handle.
1986		1994
1987	=item $iow = $iow->stop	1995	=item $iow = $iow->stop
1988		1996
1989	Stop watching for events on the given filehandle.	1997	Stop watching for events on the given file handle.
1990		1998
1991	=back	1999	=back
1992		2000
1993	=head2 The C<urxvt::iw> Class	2001	=head2 The C<urxvt::iw> Class
1994		2002
…		…
2027	->new	2035	->new
2028	->start ($pid)	2036	->start ($pid)
2029	->cb (sub {	2037	->cb (sub {
2030	my ($pw, $exit_status) = @_;	2038	my ($pw, $exit_status) = @_;
2031	...	2039	...
2032	});	2040	});
2033		2041
2034	=over 4	2042	=over 4
2035		2043
2036	=item $pw = new urxvt::pw	2044	=item $pw = new urxvt::pw
2037		2045
…		…
2041		2049
2042	Set the callback to be called when the timer triggers.	2050	Set the callback to be called when the timer triggers.
2043		2051
2044	=item $pw = $timer->start ($pid)	2052	=item $pw = $timer->start ($pid)
2045		2053
2046	Tells the wqtcher to start watching for process C<$pid>.	2054	Tells the watcher to start watching for process C<$pid>.
2047		2055
2048	=item $pw = $pw->stop	2056	=item $pw = $pw->stop
2049		2057
2050	Stop the watcher.	2058	Stop the watcher.
2051		2059
…		…
2064		2072
2065	=item >= 3 - script loading and management	2073	=item >= 3 - script loading and management
2066		2074
2067	=item >=10 - all called hooks	2075	=item >=10 - all called hooks
2068		2076
2069	=item >=11 - hook reutrn values	2077	=item >=11 - hook return values
2070		2078
2071	=back	2079	=back
2072		2080
2073	=head1 AUTHOR	2081	=head1 AUTHOR
2074		2082
2075	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
2076	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
2077		2085
2078	=cut	2086	=cut
2079		2087
2080	1	2088	1
		2089
		2090	# vim: sw=3:

Diff Legend

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