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.122 by root, Sat Jan 21 08:07:38 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	You can look at the source of the selection extension to see more
73	interesting uses, such as parsing a line from beginning to end.
74
75	This extension also offers following bindable keyboard commands:
76
77	=over 4
78
79	=item rot13
80
81	Rot-13 the selection when activated. Used via keyboard trigger:
82
83	URxvt.keysym.C-M-r: perl:selection:rot13
84
85	=back
86
87	=item option-popup (enabled by default)
88
89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90	runtime.
91
92	=item selection-popup (enabled by default)
93
94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95	text into various other formats/action (such as uri unescaping, perl
96	evaluation, web-browser starting etc.), depending on content.
97
98	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100	popup is displayed.
101
102	It's sole argument is the popup menu, which can be modified. The selection
103	is in C<$_>, which can be used to decide wether to add something or not.
104	It should either return nothing or a string and a code reference. The
105	string will be used as button text and the code reference will be called
106	when the button gets activated and should transform C<$_>.
107
108	The following will add an entry C<a to b> that transforms all C<a>s in
109	the selection to C<b>s, but only if the selection currently contains any
110	C<a>s:
111
112	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }
114	: ()
115	};
116
117	=item searchable-scrollback<hotkey> (enabled by default)
118
119	Adds regex search functionality to the scrollback buffer, triggered
120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
121	input/output is suspended and a regex is displayed at the bottom of the
122	screen.
123
124	Inputting characters appends them to the regex and continues incremental
125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
127	bottom. C<Escape> leaves search mode and returns to the point where search
128	was started, while C<Enter> or C<Return> stay at the current position and
129	additionally stores the first match in the current line into the primary
130	selection.
131
132	=item selection-autotransform
133
134	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.
136
137	It works by specifying perl snippets (most useful is a single C<s///>
138	operator) that modify C<$_> as resources:
139
140	URxvt.selection-autotransform.0: transform
141	URxvt.selection-autotransform.1: transform
142	...
143
144	For example, the following will transform selections of the form
145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
146	$word>:
147
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150	And this example matches the same,but replaces it with vi-commands you can
151	paste directly into your (vi :) editor:
152
153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155	Of course, this can be modified to suit your needs and your editor :)
156
157	To expand the example above to typical perl error messages ("XXX at
158	FILENAME line YYY."), you need a slightly more elaborate solution:
159
160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163	The first line tells the selection code to treat the unchanging part of
164	every error message as a selection pattern, and the second line transforms
165	the message into vi commands to load the file.
166
167	=item readline
168
169	A support package that tries to make editing with readline easier. At the
170	moment, it reacts to clicking with the left mouse button by trying to
171	move the text cursor to this position. It does so by generating as many
172	cursor-left or cursor-right keypresses as required (the this only works
173	for programs that correctly support wide characters).
174
175	To avoid too many false positives, this is only done when:
176
177	=over 4
178
179	=item - the mouse is on the same (multi-row-) line as the text cursor.
180
181	=item - the primary screen is currently being displayed.
182
183	=item - the text cursor is visible.
184
185	=back
186
187	The normal selection mechanism isn't disabled, so quick successive clicks
188	might interfere with selection creation in harmless ways.
189
190	=item tabbed
191
192	This transforms the terminal into a tabbar with additional terminals, that
193	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
194	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
195	button per tab.
196
197	Clicking a button will activate that tab. Pressing B<Shift-Left> and
198	B<Shift-Right> will switch to the tab left or right of the current one,
199	while B<Shift-Down> creates a new tab.
200
201	=item mark-urls
202
203	Uses per-line display filtering (C<on_line_update>) to underline urls and
204	make them clickable. When middle-clicked, the program specified in the
205	resource C<urlLauncher> (default C<x-www-browser>) will be started with
206	the URL as first argument.
207
208	=item automove-background
209
210	This is basically a one-line extension that dynamically changes the background pixmap offset
211	to the window position, in effect creating the same effect as pseudo transparency with
212	a custom pixmap. No scaling is supported in this mode. Exmaple:
213
214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
215
216	=item block-graphics-to-ascii
217
218	A not very useful example of filtering all text output to the terminal,
219	by replacing all line-drawing characters (U+2500 .. U+259F) by a
220	similar-looking ascii character.
221
222	=item digital-clock
223
224	Displays a digital clock using the built-in overlay.
225
226	=item example-refresh-hooks
227
228	Displays a very simple digital clock in the upper right corner of the
229	window. Illustrates overwriting the refresh callbacks to create your own
230	overlays or changes.
231
232	=item selection-pastebin
233
234	This is a little rarely useful extension that Uploads the selection as
235	textfile to a remote site (or does other things). (The implementation is
236	not currently secure for use in a multiuser environment as it writes to
237	F</tmp> directly.).
238
239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
240	i.e.
241
242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
243
244	Pressing this combination runs a command with C<%> replaced by the name of
245	the textfile. This command can be set via a resource:
246
247	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
248
249	And the default is likely not useful to anybody but the few people around
250	here :)
251
252	The name of the textfile is the hex encoded md5 sum of the selection, so
253	the same content should lead to the same filename.
254
255	After a successful upload the selection will be replaced by the text given
256	in the C<selection-pastebin-url> resource (again, the % is the placeholder
257	for the filename):
258
259	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
260
261	=back
262		50
263	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
264		52
265	=head2 General API Considerations	53	=head2 General API Considerations
266		54
…		…
280		68
281	=over 4	69	=over 4
282		70
283	=item $text	71	=item $text
284		72
285	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
286	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.
287		75
288	=item $string	76	=item $string
289		77
290	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
…		…
294	=item $octets	82	=item $octets
295		83
296	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
297	locale-specific way.	85	locale-specific way.
298		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
299	=back	93	=back
300		94
301	=head2 Extension Objects	95	=head2 Extension Objects
302		96
303	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
304	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,
305	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
306	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
307	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
308	use.	103	internal use.
309		104
310	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
311	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
312		107
313	It has the following methods and data members:	108	It has the following methods and data members:
…		…
334	=head2 Hooks	129	=head2 Hooks
335		130
336	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
337	called whenever the relevant event happens.	132	called whenever the relevant event happens.
338		133
339	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
340	the in the C<Extension Objects> section.	135	the in the C<Extension Objects> section.
341		136
342	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
343	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
344	relevant action might not be carried out by the C++ code.	139	relevant action might not be carried out by the C++ code.
…		…
357	place.	152	place.
358		153
359	=item on_start $term	154	=item on_start $term
360		155
361	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
362	trying to map (display) the toplevel and returning to the mainloop.	157	trying to map (display) the toplevel and returning to the main loop.
363		158
364	=item on_destroy $term	159	=item on_destroy $term
365		160
366	Called whenever something tries to destroy terminal, before doing anything	161	Called whenever something tries to destroy terminal, when the terminal is
367	yet. If this hook returns true, then destruction is skipped, but this is	162	still fully functional (not for long, though).
368	rarely a good idea.
369		163
370	=item on_reset $term	164	=item on_reset $term
371		165
372	Called after the screen is "reset" for any reason, such as resizing or	166	Called after the screen is "reset" for any reason, such as resizing or
373	control sequences. Here is where you can react on changes to size-related	167	control sequences. Here is where you can react on changes to size-related
…		…
395		189
396	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
397	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
398	by calling C<< $term->selection >>.	192	by calling C<< $term->selection >>.
399		193
400	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.
401		195
402	=item on_sel_extend $term	196	=item on_sel_extend $term
403		197
404	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
405	click) and is either supposed to return false (normal operation), or	199	click) and is either supposed to return false (normal operation), or
406	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
407	processing. This can happen multiple times, as long as the callback	201	processing. This can happen multiple times, as long as the callback
408	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
409	supposed to enlarge the selection more and more, if possible.	203	supposed to enlarge the selection more and more, if possible.
410		204
411	See the F<selection> example extension.	205	See the F<selection> example extension.
412		206
413	=item on_view_change $term, $offset	207	=item on_view_change $term, $offset
414		208
415	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
416	scrolls. Offset C<0> means display the normal terminal, positive values	210	scrolls. Offset C<0> means display the normal terminal, positive values
417	show this many lines of scrollback.	211	show this many lines of scrollback.
418		212
419	=item on_scroll_back $term, $lines, $saved	213	=item on_scroll_back $term, $lines, $saved
420		214
…		…
424		218
425	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,
426	$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
427	number of lines that will be in the scrollback buffer.	221	number of lines that will be in the scrollback buffer.
428		222
429	=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
430		234
431	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
432	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
433	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
434	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,
435	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
436	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	}
437		251
438	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,
439	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
440	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.
441		258
442	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
443		260
444	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
445	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
…		…
450	=item on_tt_write $term, $octets	267	=item on_tt_write $term, $octets
451		268
452	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
453	suppress or filter tty input.	270	suppress or filter tty input.
454		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
455	=item on_line_update $term, $row	279	=item on_line_update $term, $row
456		280
457	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
458	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
459	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,
…		…
466	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
467	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
468		292
469	=item on_refresh_begin $term	293	=item on_refresh_begin $term
470		294
471	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
472	or similar effects by modify terminal contents in refresh_begin, and	296	similar effects by modifying the terminal contents in refresh_begin, and
473	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
474	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
475		299
476	=item on_refresh_end $term	300	=item on_refresh_end $term
477		301
478	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>.
479		303
480	=item on_keyboard_command $term, $string	304	=item on_user_command $term, $string
481		305
482	Called whenever the user presses a key combination that has a	306	Called whenever a user-configured event is being activated (e.g. via
483	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>
484	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.
485		325
486	=item on_x_event $term, $event	326	=item on_x_event $term, $event
487		327
488	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
489	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
490	members are not passed.	330	members are not passed.
491		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
492	=item on_focus_in $term	336	=item on_focus_in $term
493		337
494	Called whenever the window gets the keyboard focus, before rxvt-unicode	338	Called whenever the window gets the keyboard focus, before rxvt-unicode
495	does focus in processing.	339	does focus in processing.
496		340
497	=item on_focus_out $term	341	=item on_focus_out $term
498		342
499	Called wheneever the window loses keyboard focus, before rxvt-unicode does	343	Called whenever the window loses keyboard focus, before rxvt-unicode does
500	focus out processing.	344	focus out processing.
501		345
502	=item on_configure_notify $term, $event	346	=item on_configure_notify $term, $event
503		347
504	=item on_property_notify $term, $event	348	=item on_property_notify $term, $event
…		…
515		359
516	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
517		361
518	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
519		363
520	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
521	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.
522		366
523	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
524	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
525	(real, not screen-based) row and column under the mouse cursor.	369	(real, not screen-based) row and column under the mouse cursor.
526		370
…		…
536	=item on_wm_delete_window $term, $event	380	=item on_wm_delete_window $term, $event
537		381
538	Called when various types of ClientMessage events are received (all with	382	Called when various types of ClientMessage events are received (all with
539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	383	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
540		384
		385	=item on_bell $term
		386
		387	Called on receipt of a bell character.
		388
541	=back	389	=back
542		390
543	=cut	391	=cut
544		392
545	package urxvt;	393	package urxvt;
546		394
547	use utf8;	395	use utf8;
548	use strict;	396	use strict 'vars';
549	use Carp ();	397	use Carp ();
550	use Scalar::Util ();	398	use Scalar::Util ();
551	use List::Util ();	399	use List::Util ();
552		400
553	our $VERSION = 1;	401	our $VERSION = 1;
554	our $TERM;	402	our $TERM;
555	our @TERM_INIT;	403	our @TERM_INIT; # should go, prevents async I/O etc.
556	our @TERM_EXT;	404	our @TERM_EXT; # should go, prevents async I/O etc.
557	our @HOOKNAME;	405	our @HOOKNAME;
558	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
559	our %OPTION;	407	our %OPTION;
560		408
561	our $LIBDIR;	409	our $LIBDIR;
562	our $RESNAME;	410	our $RESNAME;
563	our $RESCLASS;	411	our $RESCLASS;
564	our $RXVTNAME;	412	our $RXVTNAME;
565		413
566	our $NOCHAR = chr 0xfffe;	414	our $NOCHAR = chr 0xffff;
567		415
568	=head2 Variables in the C<urxvt> Package	416	=head2 Variables in the C<urxvt> Package
569		417
570	=over 4	418	=over 4
571		419
…		…
587	The current terminal. This variable stores the current C<urxvt::term>	435	The current terminal. This variable stores the current C<urxvt::term>
588	object, whenever a callback/hook is executing.	436	object, whenever a callback/hook is executing.
589		437
590	=item @urxvt::TERM_INIT	438	=item @urxvt::TERM_INIT
591		439
592	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
593	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
594	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,
595	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.
596		444
597	This complements to the perl-eval commandline option, but gets executed	445	This complements to the perl-eval command line option, but gets executed
598	first.	446	first.
599		447
600	=item @urxvt::TERM_EXT	448	=item @urxvt::TERM_EXT
601		449
602	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
…		…
609		457
610	=over 4	458	=over 4
611		459
612	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
613		461
614	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
615	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
616	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
617		466
618	=item urxvt::warn $string	467	=item urxvt::warn $string
619		468
620	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
621	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
622	that calls this function.	471	that calls this function.
623		472
624	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
625	correct place, e.g. on stderr of the connecting urxvtc client.	474	correct place, e.g. on stderr of the connecting urxvtc client.
626		475
627	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).
628		484
629	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
630		486
631	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
632		488
…		…
675		531
676	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
677		533
678	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
679		535
680	=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
681		538
682	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
683	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
684	the bitset.	541	the bitset.
685		542
…		…
690	Return the foreground/background colour index, respectively.	547	Return the foreground/background colour index, respectively.
691		548
692	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	549	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
693		550
694	=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
695		554
696	Replace the foreground/background colour in the rendition mask with the	555	Replace the foreground/background colour in the rendition mask with the
697	specified one.	556	specified one.
698		557
699	=item $value = urxvt::GET_CUSTOM $rend	558	=item $value = urxvt::GET_CUSTOM $rend
…		…
718	unless $msg =~ /\n$/;	577	unless $msg =~ /\n$/;
719	urxvt::warn ($msg);	578	urxvt::warn ($msg);
720	};	579	};
721	}	580	}
722		581
		582	no warnings 'utf8';
		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
723	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
724		645
725	sub verbose {	646	sub verbose {
726	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
727	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
…		…
739	$pkg =~ s/[^[:word:]]/_/g;	660	$pkg =~ s/[^[:word:]]/_/g;
740	$pkg = "urxvt::ext::$pkg";	661	$pkg = "urxvt::ext::$pkg";
741		662
742	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
743		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		666
744	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
745	or die "$path: $!";	668	or die "$path: $!";
746		669
747	my $source =	670	my $source =
748	"package $pkg; use strict; use utf8;\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
749	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
750	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
751	. "\n};\n1";	674	. "\n};\n1";
752		675
753	eval $source	676	eval $source
…		…
763	sub invoke {	686	sub invoke {
764	local $TERM = shift;	687	local $TERM = shift;
765	my $htype = shift;	688	my $htype = shift;
766		689
767	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
768	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
769		692
770	my %ext_arg;	693	my %ext_arg;
771		694
772	{	695	{
773	my @init = @TERM_INIT;	696	my @init = @TERM_INIT;
774	@TERM_INIT = ();	697	@TERM_INIT = ();
…		…
776	my @pkg = @TERM_EXT;	699	my @pkg = @TERM_EXT;
777	@TERM_EXT = ();	700	@TERM_EXT = ();
778	$TERM->register_package ($_) for @pkg;	701	$TERM->register_package ($_) for @pkg;
779	}	702	}
780		703
		704	for (
		705	@{ delete $TERM->{perl_ext_3} },
781	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
782	if ($_ eq "default") {	708	if ($_ eq "default") {
783	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	709	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
784	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
785	delete $ext_arg{$1};	711	delete $ext_arg{$1};
786	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
787	push @{ $ext_arg{$1} }, $2;	713	push @{ $ext_arg{$1} }, $2;
788	} else {	714	} else {
789	$ext_arg{$_} ||= [];	715	$ext_arg{$_} ||= [];
790	}	716	}
791	}	717	}
792		718
793	while (my ($ext, $argv) = each %ext_arg) {	719	for my $ext (sort keys %ext_arg) {
794	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
795		721
796	if (@files) {	722	if (@files) {
797	$TERM->register_package (extension_package $files[0], $argv);	723	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
798	} else {	724	} else {
799	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";
800	}	726	}
801	}	727	}
802		728
…		…
808		734
809	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
810	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
811	if $verbosity >= 10;	737	if $verbosity >= 10;
812		738
813	keys %$cb;	739	for my $pkg (keys %$cb) {
814
815	while (my ($pkg, $cb) = each %$cb) {
816	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
817	$retval ||= $retval_;	741	$retval ||= $retval_;
818		742
819	if ($@) {	743	if ($@) {
820	$TERM->ungrab; # better to lose the grab than the session	744	$TERM->ungrab; # better to lose the grab than the session
821	warn $@;	745	warn $@;
…		…
835	}	759	}
836		760
837	$retval	761	$retval
838	}	762	}
839		763
840	# 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	}
841		792
842	package urxvt::term::extension;	793	package urxvt::term::extension;
843		794
844	sub enable {	795	sub enable {
845	my ($self, %hook) = @_;	796	my ($self, %hook) = @_;
…		…
900		851
901	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
902	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
903	}	854	}
904		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
905	package urxvt::anyevent;	868	package urxvt::anyevent;
906		869
907	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
908		871
909	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
910	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
911	further programming. The only exception is that you cannot wait on	874	further programming. The only exception is that you cannot wait on
912	condition variables, but non-blocking condvar use is ok. What this means	875	condition variables, but non-blocking condvar use is ok.
913	is that you cannot use blocking APIs, but the non-blocking variant should	876
914	work.	877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
915		879
916	=cut	880	=cut
917		881
918	our $VERSION = 1;	882	our $VERSION = '5.23';
919		883
920	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
921	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
922		886
923	sub timer {	887	sub timer {
…		…
925		889
926	my $cb = $arg{cb};	890	my $cb = $arg{cb};
927		891
928	urxvt::timer	892	urxvt::timer
929	->new	893	->new
930	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
931	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
932	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
933	$cb->();	897	$cb->();
934	})	898	})
935	}	899	}
936		900
937	sub io {	901	sub io {
938	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
939		903
940	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
941		907
942	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
943	->new	909	->new
944	->fd (fileno $arg{fh})	910	->fd ($fd)
945	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
946	| ($arg{poll} =~ /w/ ? 2 : 0))	912	| ($arg{poll} =~ /w/ ? 2 : 0))
947	->start	913	->start
948	->cb (sub {	914	->cb ($cb)
949	$cb->(($_[1] & 1 ? 'r' : '')
950	. ($_[1] & 2 ? 'w' : ''));
951	})],
952	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	})
953	}	941	}
954		942
955	sub DESTROY {	943	sub DESTROY {
956	$_[0][1]->stop;	944	$_[0][1]->stop;
957	}	945	}
958		946
959	sub condvar {	947	# only needed for AnyEvent < 6 compatibility
960	bless \my $flag, urxvt::anyevent::condvar::	948	sub one_event {
961	}
962
963	sub urxvt::anyevent::condvar::broadcast {
964	${$_[0]}++;
965	}
966
967	sub urxvt::anyevent::condvar::wait {
968	unless (${$_[0]}) {
969	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";
970	}
971	}	950	}
972		951
973	package urxvt::term;	952	package urxvt::term;
974		953
975	=head2 The C<urxvt::term> Class	954	=head2 The C<urxvt::term> Class
…		…
988	urxvt::verbose 6, "register package $pkg to $self";	967	urxvt::verbose 6, "register package $pkg to $self";
989		968
990	@{"$pkg\::ISA"} = urxvt::term::extension::;	969	@{"$pkg\::ISA"} = urxvt::term::extension::;
991		970
992	my $proxy = bless {	971	my $proxy = bless {
993	_pkg => $pkg,	972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
994	argv => $argv,	974	argv => $argv,
995	}, $pkg;	975	}, $pkg;
996	Scalar::Util::weaken ($proxy->{term} = $self);	976	Scalar::Util::weaken ($proxy->{term} = $self);
997		977
998	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
999		979
…		…
1002	$proxy->enable ($name => $ref);	982	$proxy->enable ($name => $ref);
1003	}	983	}
1004	}	984	}
1005	}	985	}
1006		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
1007	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1008		1035
1009	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
1010	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
1011	hash which defines the environment of the new terminal.	1038	hash which defines the environment of the new terminal.
1012		1039
1013	Croaks (and probably outputs an error message) if the new instance	1040	Croaks (and probably outputs an error message) if the new instance
1014	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
1015	initialise perl, and the terminal object otherwise. The C<init> and	1042	initialise perl, and the terminal object otherwise. The C<init> and
1016	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).
1017		1045
1018	=cut	1046	=cut
1019		1047
1020	sub new {	1048	sub new {
1021	my ($class, $env, @args) = @_;	1049	my ($class, $env, @args) = @_;
1022		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
1023	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1054	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1024	}	1055	}
1025		1056
1026	=item $term->destroy	1057	=item $term->destroy
1027		1058
1028	Destroy the terminal object (close the window, free resources	1059	Destroy the terminal object (close the window, free resources
…		…
1058		1089
1059	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
1060	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
1061	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.
1062		1093
1063	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
1064	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
1065		1096
1066	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
1067	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1068	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1069	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1070	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1071	transparent tripleclickwords utmpInhibit visualBell	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1103	urgentOnBell utmpInhibit visualBell
1072		1104
1073	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
1074		1106
1075	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
1076	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>
…		…
1085	likely change).	1117	likely change).
1086		1118
1087	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
1088	terminal is destroyed, so changing options frequently will eat memory.	1120	terminal is destroyed, so changing options frequently will eat memory.
1089		1121
1090	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
1091	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>
1092	to see the actual list:	1124	to see the actual list:
1093		1125
1094	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1095	borderLess color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1096	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1097	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
1098	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1099	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1100	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1101	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1102	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1103	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1104	secondaryScreen secondaryScroll selectstyle shade term_name title	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1105	transient_for transparent transparent_all tripleclickwords utmpInhibit	1138	term_name title transient_for transparent tripleclickwords urgentOnBell
1106	visualBell	1139	utmpInhibit visualBell
1107		1140
1108	=cut	1141	=cut
1109		1142
1110	sub resource($$;$) {	1143	sub resource($$;$) {
1111	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
1112	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1145	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1113	&urxvt::term::_resource	1146	goto &urxvt::term::_resource
1114	}	1147	}
1115		1148
1116	=item $value = $term->x_resource ($pattern)	1149	=item $value = $term->x_resource ($pattern)
1117		1150
1118	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
1119	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
1120	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
1121	resource with that pattern exists.	1154	resource with that pattern exists.
1122		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
1123	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
1124	only one resource database per display, and later invocations might return	1167	only one resource database per display, and later invocations might return
1125	the wrong resources.	1168	the wrong resources.
1126		1169
1127	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1170	=item $value = $term->x_resource_boolean ($pattern)
1128		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
1129	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
1130	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.
1131		1197
1132	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
1133		1199
1134	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
1135	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
1143		1209
1144	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
1145		1211
1146	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
1147		1213
1148	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.
1149	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.
1150		1223
1151	=item $term->selection_make ($eventtime[, $rectangular])	1224	=item $term->selection_make ($eventtime[, $rectangular])
1152		1225
1153	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
1154	C<selection_end>. If C<$rectangular> is true (default: false), a	1227	C<selection_end>. If C<$rectangular> is true (default: false), a
1155	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
1156	a selection.	1229	a selection.
1157		1230
1158	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1159		1232
1160	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
1161	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
1162	is mostly useful from within C<on_sel_grab> hooks.	1236	is mostly useful from within C<on_sel_grab> hooks.
1163		1237
1164	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
1165		1239
1166	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.
1167		1246
1168	=item $term->overlay_simple ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
1169		1248
1170	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.
1171		1250
…		…
1201		1280
1202	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
1203		1282
1204	=over 4	1283	=over 4
1205		1284
1206	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
1207		1286
1208	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
1209	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
1210	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.
1211		1292
1212	=item $overlay->hide	1293	=item $overlay->hide
1213		1294
1214	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
1215		1296
…		…
1297	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
1298	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
1299		1380
1300	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
1301		1382
1302	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
1303	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
1304	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.
1305		1392
1306	=item $old_events = $term->pty_ev_events ([$new_events])	1393	=item $old_events = $term->pty_ev_events ([$new_events])
1307		1394
1308	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
1309	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
1310	description of C<< urxvt::timer->events >>. Make sure to always restore	1397	description of C<< urxvt::timer->events >>. Make sure to always restore
1311	the previous value.	1398	the previous value.
1312		1399
		1400	=item $fd = $term->pty_fd
		1401
		1402	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1403	is used.
		1404
1313	=item $windowid = $term->parent	1405	=item $windowid = $term->parent
1314		1406
1315	Return the window id of the toplevel window.	1407	Return the window id of the toplevel window.
1316		1408
1317	=item $windowid = $term->vt	1409	=item $windowid = $term->vt
…		…
1323	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
1324	to receive pointer events all the times:	1416	to receive pointer events all the times:
1325		1417
1326	$term->vt_emask_add (urxvt::PointerMotionMask);	1418	$term->vt_emask_add (urxvt::PointerMotionMask);
1327		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
1328	=item $window_width = $term->width	1434	=item $window_width = $term->width
1329		1435
1330	=item $window_height = $term->height	1436	=item $window_height = $term->height
1331		1437
1332	=item $font_width = $term->fwidth	1438	=item $font_width = $term->fwidth
…		…
1362	=item $env = $term->env	1468	=item $env = $term->env
1363		1469
1364	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
1365	similar to C<\%ENV>.	1471	similar to C<\%ENV>.
1366		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
1367	=cut	1482	=cut
1368		1483
1369	sub env {	1484	sub env {
1370	if (my $env = $_[0]->_env) {
1371	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1485	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1372	} else {
1373	+{ %ENV }
1374	}
1375	}	1486	}
1376		1487
1377	=item $modifiermask = $term->ModLevel3Mask	1488	=item $modifiermask = $term->ModLevel3Mask
1378		1489
1379	=item $modifiermask = $term->ModMetaMask	1490	=item $modifiermask = $term->ModMetaMask
…		…
1387		1498
1388	Returns the currently displayed screen (0 primary, 1 secondary).	1499	Returns the currently displayed screen (0 primary, 1 secondary).
1389		1500
1390	=item $cursor_is_hidden = $term->hidden_cursor	1501	=item $cursor_is_hidden = $term->hidden_cursor
1391		1502
1392	Returns wether the cursor is currently hidden or not.	1503	Returns whether the cursor is currently hidden or not.
1393		1504
1394	=item $view_start = $term->view_start ([$newvalue])	1505	=item $view_start = $term->view_start ([$newvalue])
1395		1506
1396	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
1397	C<0>, which displays the normal terminal contents. Lower values scroll	1508	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1405		1516
1406	Used after changing terminal contents to display them.	1517	Used after changing terminal contents to display them.
1407		1518
1408	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1409		1520
1410	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 >>
1411	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
1412	terminal line. The scrollback buffer starts at line C<-1> and extends to
1413	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1523	terminal line. Nothing will be returned if a nonexistent line
1414	is requested.	1524	is requested.
1415		1525
1416	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
1417	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
1418	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
1419	automatically be updated.	1529	automatically be updated.
1420		1530
1421	C<$text> is in a special encoding: tabs and wide characters that use	1531	C<$text> is in a special encoding: tabs and wide characters that use more
1422	more than one cell when displayed are padded with C<$urxvt::NOCHAR>	1532	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1423	characters. Characters with combining characters and other characters that	1533	characters. Characters with combining characters and other characters that
1424	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
1425	in the private use area.	1535	in the private use area.
1426		1536
1427	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
1428	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
1429	characters.	1539	characters.
…		…
1574	where one character corresponds to one screen cell. See	1684	where one character corresponds to one screen cell. See
1575	C<< $term->ROW_t >> for details.	1685	C<< $term->ROW_t >> for details.
1576		1686
1577	=item $string = $term->special_decode $text	1687	=item $string = $term->special_decode $text
1578		1688
1579	Converts rxvt-unicodes text reprsentation into a perl string. See	1689	Converts rxvt-unicodes text representation into a perl string. See
1580	C<< $term->ROW_t >> for details.	1690	C<< $term->ROW_t >> for details.
1581		1691
1582	=item $success = $term->grab_button ($button, $modifiermask)	1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1583		1693
		1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1695
1584	Registers a synchronous button grab. See the XGrabButton manpage.	1696	Register/unregister a synchronous button grab. See the XGrabButton
		1697	manpage.
1585		1698
1586	=item $success = $term->grab ($eventtime[, $sync])	1699	=item $success = $term->grab ($eventtime[, $sync])
1587		1700
1588	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1701	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1589	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1702	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1590		1703
1591	=item $term->allow_events_async	1704	=item $term->allow_events_async
1592		1705
1593	Calls XAllowEvents with AsyncBoth for the most recent grab.	1706	Calls XAllowEvents with AsyncBoth for the most recent grab.
1594		1707
…		…
1601	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1602	recent grab.	1715	recent grab.
1603		1716
1604	=item $term->ungrab	1717	=item $term->ungrab
1605		1718
1606	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
1607	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
1608	the session.	1721	the session.
1609		1722
1610	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1723	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1611		1724
…		…
1613		1726
1614	=item @atoms = $term->XListProperties ($window)	1727	=item @atoms = $term->XListProperties ($window)
1615		1728
1616	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1729	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1617		1730
1618	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1731	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1619		1732
1620	=item $term->XDeleteProperty ($window, $property)	1733	=item $term->XDeleteProperty ($window, $property)
1621		1734
1622	=item $window = $term->DefaultRootWindow	1735	=item $window = $term->DefaultRootWindow
1623		1736
…		…
1630	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1743	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1631		1744
1632	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1745	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1633		1746
1634	=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)
1635		1752
1636	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
1637	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
1638	directory onto the X functions of the same name.	1755	directly onto the X functions of the same name.
1639		1756
1640	=back	1757	=back
1641		1758
1642	=cut	1759	=cut
1643		1760
…		…
1707	my ($self, $text, $cb) = @_;	1824	my ($self, $text, $cb) = @_;
1708		1825
1709	$self->add_item ({ type => "button", text => $text, activate => $cb});	1826	$self->add_item ({ type => "button", text => $text, activate => $cb});
1710	}	1827	}
1711		1828
1712	=item $popup->add_toggle ($text, $cb, $initial_value)	1829	=item $popup->add_toggle ($text, $initial_value, $cb)
1713		1830
1714	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
1715	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
1716	argument.	1833	first argument.
1717		1834
1718	=cut	1835	=cut
1719		1836
1720	sub add_toggle {	1837	sub add_toggle {
1721	my ($self, $text, $cb, $value) = @_;	1838	my ($self, $text, $value, $cb) = @_;
1722		1839
1723	my $item; $item = {	1840	my $item; $item = {
1724	type => "button",	1841	type => "button",
1725	text => " $text",	1842	text => " $text",
1726	value => $value,	1843	value => $value,
…		…
1745	my $env = $self->{term}->env;	1862	my $env = $self->{term}->env;
1746	# 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.
1747	delete $env->{LC_ALL};	1864	delete $env->{LC_ALL};
1748	$env->{LC_CTYPE} = $self->{term}->locale;	1865	$env->{LC_CTYPE} = $self->{term}->locale;
1749		1866
1750	urxvt::term->new ($env, "popup",	1867	my $term = urxvt::term->new (
		1868	$env, "popup",
1751	"--perl-lib" => "", "--perl-ext-common" => "",	1869	"--perl-lib" => "", "--perl-ext-common" => "",
1752	"-pty-fd" => -1, "-sl" => 0,	1870	"-pty-fd" => -1, "-sl" => 0,
1753	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1871	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1754	"--transient-for" => $self->{term}->parent,	1872	"--transient-for" => $self->{term}->parent,
1755	"-display" => $self->{term}->display_id,	1873	"-display" => $self->{term}->display_id,
1756	"-pe" => "urxvt-popup")	1874	"-pe" => "urxvt-popup",
1757	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	}
1758	}	1882	}
1759		1883
1760	sub DESTROY {	1884	sub DESTROY {
1761	my ($self) = @_;	1885	my ($self) = @_;
1762		1886
…		…
1767	=back	1891	=back
1768		1892
1769	=cut	1893	=cut
1770		1894
1771	package urxvt::watcher;	1895	package urxvt::watcher;
1772
1773	@urxvt::timer::ISA = __PACKAGE__;
1774	@urxvt::iow::ISA = __PACKAGE__;
1775	@urxvt::pw::ISA = __PACKAGE__;
1776	@urxvt::iw::ISA = __PACKAGE__;
1777		1896
1778	=head2 The C<urxvt::timer> Class	1897	=head2 The C<urxvt::timer> Class
1779		1898
1780	This class implements timer watchers/events. Time is represented as a	1899	This class implements timer watchers/events. Time is represented as a
1781	fractional number of seconds since the epoch. Example:	1900	fractional number of seconds since the epoch. Example:
…		…
1785	->new	1904	->new
1786	->interval (1)	1905	->interval (1)
1787	->cb (sub {	1906	->cb (sub {
1788	$term->{overlay}->set (0, 0,	1907	$term->{overlay}->set (0, 0,
1789	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1790	});	1909	});
1791		1910
1792	=over 4	1911	=over 4
1793		1912
1794	=item $timer = new urxvt::timer	1913	=item $timer = new urxvt::timer
1795		1914
…		…
1798		1917
1799	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1800		1919
1801	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
1802		1921
1803	=item $tstamp = $timer->at
1804
1805	Return the time this watcher will fire next.
1806
1807	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
1808		1923
1809	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).
1810		1926
1811	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
1812		1928
1813	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
1814	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
1815	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
1816		1932
1817	=item $timer = $timer->start	1933	=item $timer = $timer->start
1818		1934
1819	Start the timer.	1935	Start the timer.
1820		1936
1821	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
1822		1938
1823	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.
1824		1941
1825	=item $timer = $timer->after ($delay)	1942	=item $timer = $timer->after ($delay[, $interval])
1826		1943
1827	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>.
1828		1945
1829	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
1830		1947
…		…
1838		1955
1839	$term->{socket} = ...	1956	$term->{socket} = ...
1840	$term->{iow} = urxvt::iow	1957	$term->{iow} = urxvt::iow
1841	->new	1958	->new
1842	->fd (fileno $term->{socket})	1959	->fd (fileno $term->{socket})
1843	->events (urxvt::EVENT_READ)	1960	->events (urxvt::EV_READ)
1844	->start	1961	->start
1845	->cb (sub {	1962	->cb (sub {
1846	my ($iow, $revents) = @_;	1963	my ($iow, $revents) = @_;
1847	# $revents must be 1 here, no need to check	1964	# $revents must be 1 here, no need to check
1848	sysread $term->{socket}, my $buf, 8192	1965	sysread $term->{socket}, my $buf, 8192
…		…
1861	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>
1862	is a bitset as described in the C<events> method.	1979	is a bitset as described in the C<events> method.
1863		1980
1864	=item $iow = $iow->fd ($fd)	1981	=item $iow = $iow->fd ($fd)
1865		1982
1866	Set the filedescriptor (not handle) to watch.	1983	Set the file descriptor (not handle) to watch.
1867		1984
1868	=item $iow = $iow->events ($eventmask)	1985	=item $iow = $iow->events ($eventmask)
1869		1986
1870	Set the event mask to watch. The only allowed values are	1987	Set the event mask to watch. The only allowed values are
1871	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
1872	together, or C<urxvt::EVENT_NONE>.	1989	together, or C<urxvt::EV_NONE>.
1873		1990
1874	=item $iow = $iow->start	1991	=item $iow = $iow->start
1875		1992
1876	Start watching for requested events on the given handle.	1993	Start watching for requested events on the given handle.
1877		1994
1878	=item $iow = $iow->stop	1995	=item $iow = $iow->stop
1879		1996
1880	Stop watching for events on the given filehandle.	1997	Stop watching for events on the given file handle.
1881		1998
1882	=back	1999	=back
1883		2000
1884	=head2 The C<urxvt::iw> Class	2001	=head2 The C<urxvt::iw> Class
1885		2002
…		…
1918	->new	2035	->new
1919	->start ($pid)	2036	->start ($pid)
1920	->cb (sub {	2037	->cb (sub {
1921	my ($pw, $exit_status) = @_;	2038	my ($pw, $exit_status) = @_;
1922	...	2039	...
1923	});	2040	});
1924		2041
1925	=over 4	2042	=over 4
1926		2043
1927	=item $pw = new urxvt::pw	2044	=item $pw = new urxvt::pw
1928		2045
…		…
1932		2049
1933	Set the callback to be called when the timer triggers.	2050	Set the callback to be called when the timer triggers.
1934		2051
1935	=item $pw = $timer->start ($pid)	2052	=item $pw = $timer->start ($pid)
1936		2053
1937	Tells the wqtcher to start watching for process C<$pid>.	2054	Tells the watcher to start watching for process C<$pid>.
1938		2055
1939	=item $pw = $pw->stop	2056	=item $pw = $pw->stop
1940		2057
1941	Stop the watcher.	2058	Stop the watcher.
1942		2059
…		…
1955		2072
1956	=item >= 3 - script loading and management	2073	=item >= 3 - script loading and management
1957		2074
1958	=item >=10 - all called hooks	2075	=item >=10 - all called hooks
1959		2076
1960	=item >=11 - hook reutrn values	2077	=item >=11 - hook return values
1961		2078
1962	=back	2079	=back
1963		2080
1964	=head1 AUTHOR	2081	=head1 AUTHOR
1965		2082
1966	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
1967	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
1968		2085
1969	=cut	2086	=cut
1970		2087
1971	1	2088	1
		2089
		2090	# vim: sw=3:

Diff Legend

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