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.95 by elmex, Tue Jan 17 13:19:45 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	=over 4	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	=item selection (enabled by default)	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	Extensions that add command line parameters or resources on their own are
45	when the user extends selections (double-click and further clicks). Right	49	laoded automatically when used.
46	now, it tries to select words, urls and complete shell-quoted
47	arguments, which is very convenient, too, if your F<ls> supports
48	C<--quoting-style=shell>.
49
50	A double-click usually selects the word under the cursor, further clicks
51	will enlarge the selection.
52
53	The selection works by trying to match a number of regexes and displaying
54	them in increasing order of length. You can add your own regexes by
55	specifying resources of the form:
56
57	URxvt.selection.pattern-0: perl-regex
58	URxvt.selection.pattern-1: perl-regex
59	...
60
61	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:
65
66	URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.
70
71	This extension also offers following bindable keyboard commands:
72
73	=over 4
74
75	=item rot13
76
77	Rot-13 the selection when activated. Used via keyboard trigger:
78
79	URxvt.keysym.C-M-r: perl:selection:rot13
80
81	=item remote-pastebin
82
83	Upload the selection as textfile to a remote site.
84
85	URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87	To set the command to upload the file set this resource:
88
89	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92	md5 sum of the selection.
93	After an successful upload the selection will be replaced by the following url
94	(the % is the placeholder for the filename):
95
96	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
97
98	=back
99
100	=item option-popup (enabled by default)
101
102	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
103	runtime.
104
105	=item selection-popup (enabled by default)
106
107	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
108	text into various other formats/action (such as uri unescaping, perl
109	evalution, web-browser starting etc.), depending on content.
110
111	=item searchable-scrollback<hotkey> (enabled by default)
112
113	Adds regex search functionality to the scrollback buffer, triggered
114	by a hotkey (default: C<M-s>). While in search mode, normal terminal
115	input/output is suspended and a regex is displayed at the bottom of the
116	screen.
117
118	Inputting characters appends them to the regex and continues incremental
119	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
120	search upwards/downwards in the scrollback buffer, C<End> jumps to the
121	bottom. C<Escape> leaves search mode and returns to the point where search
122	was started, while C<Enter> or C<Return> stay at the current position and
123	additionally stores the first match in the current line into the primary
124	selection.
125
126	=item selection-autotransform
127
128	This selection allows you to do automatic transforms on a selection
129	whenever a selection is made.
130
131	It works by specifying perl snippets (most useful is a single C<s///>
132	operator) that modify C<$_> as resources:
133
134	URxvt.selection-autotransform.0: transform
135	URxvt.selection-autotransform.1: transform
136	...
137
138	For example, the following will transform selections of the form
139	C<filename:number>, often seen in compiler messages, into C<vi +$filename
140	$word>:
141
142	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
143
144	And this example matches the same,but replaces it with vi-commands you can
145	paste directly into your (vi :) editor:
146
147	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
148
149	Of course, this can be modified to suit your needs and your editor :)
150
151	To expand the example above to typical perl error messages ("XXX at
152	FILENAME line YYY."), you need a slightly more elaborate solution:
153
154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
155	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
156
157	The first line tells the selection code to treat the unchanging part of
158	every error message as a selection pattern, and the second line transforms
159	the message into vi commands to load the file.
160
161	=item mark-urls
162
163	Uses per-line display filtering (C<on_line_update>) to underline urls and
164	make them clickable. When middle-clicked, the program specified in the
165	resource C<urlLauncher> (default C<x-www-browser>) will be started with
166	the URL as first argument.
167
168	=item block-graphics-to-ascii
169
170	A not very useful example of filtering all text output to the terminal,
171	by replacing all line-drawing characters (U+2500 .. U+259F) by a
172	similar-looking ascii character.
173
174	=item digital-clock
175
176	Displays a digital clock using the built-in overlay.
177
178	=item example-refresh-hooks
179
180	Displays a very simple digital clock in the upper right corner of the
181	window. Illustrates overwriting the refresh callbacks to create your own
182	overlays or changes.
183
184	=back
185		50
186	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
187		52
188	=head2 General API Considerations	53	=head2 General API Considerations
189		54
…		…
203		68
204	=over 4	69	=over 4
205		70
206	=item $text	71	=item $text
207		72
208	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
209	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.
210		75
211	=item $string	76	=item $string
212		77
213	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
…		…
217	=item $octets	82	=item $octets
218		83
219	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
220	locale-specific way.	85	locale-specific way.
221		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
222	=back	93	=back
223		94
224	=head2 Extension Objects	95	=head2 Extension Objects
225		96
226	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
227	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,
228	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
229	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
230	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
231	use.	103	internal use.
232		104
233	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
234	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
235		107
236	It has the following methods and data members:	108	It has the following methods and data members:
…		…
257	=head2 Hooks	129	=head2 Hooks
258		130
259	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
260	called whenever the relevant event happens.	132	called whenever the relevant event happens.
261		133
262	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
263	the in the C<Extension Objects> section.	135	the in the C<Extension Objects> section.
264		136
265	B<All> of these hooks must return a boolean value. If it is true, then the	137	B<All> of these hooks must return a boolean value. If any of the called
266	event counts as being I<consumed>, and the invocation of other hooks is	138	hooks returns true, then the event counts as being I<consumed>, and the
267	skipped, and the relevant action might not be carried out by the C++ code.	139	relevant action might not be carried out by the C++ code.
268		140
269	I<< When in doubt, return a false value (preferably C<()>). >>	141	I<< When in doubt, return a false value (preferably C<()>). >>
270		142
271	=over 4	143	=over 4
272		144
273	=item on_init $term	145	=item on_init $term
274		146
275	Called after a new terminal object has been initialized, but before	147	Called after a new terminal object has been initialized, but before
276	windows are created or the command gets run. Most methods are unsafe to	148	windows are created or the command gets run. Most methods are unsafe to
277	call or deliver senseless data, as terminal size and other characteristics	149	call or deliver senseless data, as terminal size and other characteristics
278	have not yet been determined. You can safely query and change resources,	150	have not yet been determined. You can safely query and change resources
279	though.	151	and options, though. For many purposes the C<on_start> hook is a better
		152	place.
		153
		154	=item on_start $term
		155
		156	Called at the very end of initialisation of a new terminal, just before
		157	trying to map (display) the toplevel and returning to the main loop.
		158
		159	=item on_destroy $term
		160
		161	Called whenever something tries to destroy terminal, when the terminal is
		162	still fully functional (not for long, though).
280		163
281	=item on_reset $term	164	=item on_reset $term
282		165
283	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
284	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
285	variables.	168	variables.
286		169
287	=item on_start $term	170	=item on_child_start $term, $pid
288		171
289	Called at the very end of initialisation of a new terminal, just before	172	Called just after the child process has been C<fork>ed.
290	returning to the mainloop.	173
		174	=item on_child_exit $term, $status
		175
		176	Called just after the child process has exited. C<$status> is the status
		177	from C<waitpid>.
291		178
292	=item on_sel_make $term, $eventtime	179	=item on_sel_make $term, $eventtime
293		180
294	Called whenever a selection has been made by the user, but before the	181	Called whenever a selection has been made by the user, but before the
295	selection text is copied, so changes to the beginning, end or type of the	182	selection text is copied, so changes to the beginning, end or type of the
…		…
302		189
303	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
304	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
305	by calling C<< $term->selection >>.	192	by calling C<< $term->selection >>.
306		193
307	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.
308		195
309	=item on_sel_extend $term	196	=item on_sel_extend $term
310		197
311	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
312	click) and is either supposed to return false (normal operation), or	199	click) and is either supposed to return false (normal operation), or
313	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
314	processing. This can happen multiple times, as long as the callback	201	processing. This can happen multiple times, as long as the callback
315	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
316	supposed to enlarge the selection more and more, if possible.	203	supposed to enlarge the selection more and more, if possible.
317		204
318	See the F<selection> example extension.	205	See the F<selection> example extension.
319		206
320	=item on_view_change $term, $offset	207	=item on_view_change $term, $offset
321		208
322	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
323	scrolls. Offset C<0> means display the normal terminal, positive values	210	scrolls. Offset C<0> means display the normal terminal, positive values
324	show this many lines of scrollback.	211	show this many lines of scrollback.
325		212
326	=item on_scroll_back $term, $lines, $saved	213	=item on_scroll_back $term, $lines, $saved
327		214
…		…
331		218
332	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,
333	$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
334	number of lines that will be in the scrollback buffer.	221	number of lines that will be in the scrollback buffer.
335		222
336	=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
337		234
338	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
339	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
340	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
341	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,
342	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
343	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	}
344		251
345	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,
346	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
347	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.
348		258
349	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
350		260
351	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
352	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
…		…
357	=item on_tt_write $term, $octets	267	=item on_tt_write $term, $octets
358		268
359	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
360	suppress or filter tty input.	270	suppress or filter tty input.
361		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
362	=item on_line_update $term, $row	279	=item on_line_update $term, $row
363		280
364	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
365	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
366	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,
…		…
373	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
374	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
375		292
376	=item on_refresh_begin $term	293	=item on_refresh_begin $term
377		294
378	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
379	or similar effects by modify terminal contents in refresh_begin, and	296	similar effects by modifying the terminal contents in refresh_begin, and
380	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
381	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
382		299
383	=item on_refresh_end $term	300	=item on_refresh_end $term
384		301
385	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>.
386		303
387	=item on_keyboard_command $term, $string	304	=item on_user_command $term, $string
388		305
389	Called whenever the user presses a key combination that has a	306	Called whenever a user-configured event is being activated (e.g. via
390	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>
391	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.
392		325
393	=item on_x_event $term, $event	326	=item on_x_event $term, $event
394		327
395	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
396	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
397	members are not passed.	330	members are not passed.
398		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
399	=item on_focus_in $term	336	=item on_focus_in $term
400		337
401	Called whenever the window gets the keyboard focus, before rxvt-unicode	338	Called whenever the window gets the keyboard focus, before rxvt-unicode
402	does focus in processing.	339	does focus in processing.
403		340
404	=item on_focus_out $term	341	=item on_focus_out $term
405		342
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	343	Called whenever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	344	focus out processing.
408		345
		346	=item on_configure_notify $term, $event
		347
		348	=item on_property_notify $term, $event
		349
409	=item on_key_press $term, $event, $keysym, $octets	350	=item on_key_press $term, $event, $keysym, $octets
410		351
411	=item on_key_release $term, $event, $keysym	352	=item on_key_release $term, $event, $keysym
412		353
413	=item on_button_press $term, $event	354	=item on_button_press $term, $event
…		…
418		359
419	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
420		361
421	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
422		363
423	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
424	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.
425		366
426	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
427	manpage), with the additional members C<row> and C<col>, which are the row	368	manpage), with the additional members C<row> and C<col>, which are the
428	and column under the mouse cursor.	369	(real, not screen-based) row and column under the mouse cursor.
429		370
430	C<on_key_press> additionally receives the string rxvt-unicode would	371	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	372	output, if any, in locale-specific encoding.
432		373
433	subwindow.	374	subwindow.
434		375
		376	=item on_client_message $term, $event
		377
		378	=item on_wm_protocols $term, $event
		379
		380	=item on_wm_delete_window $term, $event
		381
		382	Called when various types of ClientMessage events are received (all with
		383	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		384
		385	=item on_bell $term
		386
		387	Called on receipt of a bell character.
		388
435	=back	389	=back
436		390
437	=cut	391	=cut
438		392
439	package urxvt;	393	package urxvt;
440		394
441	use utf8;	395	use utf8;
442	use strict;	396	use strict 'vars';
443	use Carp ();	397	use Carp ();
444	use Scalar::Util ();	398	use Scalar::Util ();
445	use List::Util ();	399	use List::Util ();
446		400
447	our $VERSION = 1;	401	our $VERSION = 1;
448	our $TERM;	402	our $TERM;
		403	our @TERM_INIT; # should go, prevents async I/O etc.
		404	our @TERM_EXT; # should go, prevents async I/O etc.
449	our @HOOKNAME;	405	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	407	our %OPTION;
452		408
453	our $LIBDIR;	409	our $LIBDIR;
454	our $RESNAME;	410	our $RESNAME;
455	our $RESCLASS;	411	our $RESCLASS;
456	our $RXVTNAME;	412	our $RXVTNAME;
457		413
		414	our $NOCHAR = chr 0xffff;
		415
458	=head2 Variables in the C<urxvt> Package	416	=head2 Variables in the C<urxvt> Package
459		417
460	=over 4	418	=over 4
461		419
462	=item $urxvt::LIBDIR	420	=item $urxvt::LIBDIR
…		…
475	=item $urxvt::TERM	433	=item $urxvt::TERM
476		434
477	The current terminal. This variable stores the current C<urxvt::term>	435	The current terminal. This variable stores the current C<urxvt::term>
478	object, whenever a callback/hook is executing.	436	object, whenever a callback/hook is executing.
479		437
		438	=item @urxvt::TERM_INIT
		439
		440	All code references in this array will be called as methods of the next newly
		441	created C<urxvt::term> object (during the C<on_init> phase). The array
		442	gets cleared before the code references that were in it are being executed,
		443	so references can push themselves onto it again if they so desire.
		444
		445	This complements to the perl-eval command line option, but gets executed
		446	first.
		447
		448	=item @urxvt::TERM_EXT
		449
		450	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		451	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		452	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		453
480	=back	454	=back
481		455
482	=head2 Functions in the C<urxvt> Package	456	=head2 Functions in the C<urxvt> Package
483		457
484	=over 4	458	=over 4
485		459
486	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
487		461
488	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
489	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
490	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
491		466
492	=item urxvt::warn $string	467	=item urxvt::warn $string
493		468
494	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
495	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
496	that calls this function.	471	that calls this function.
497		472
498	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
499	correct place, e.g. on stderr of the connecting urxvtc client.	474	correct place, e.g. on stderr of the connecting urxvtc client.
500		475
501	Messages have a size limit of 1023 bytes currently.	476	Messages have a size limit of 1023 bytes currently.
502		477
503	=item $is_safe = urxvt::safe	478	=item @terms = urxvt::termlist
504		479
505	Returns true when it is safe to do potentially unsafe things, such as	480	Returns all urxvt::term objects that exist in this process, regardless of
506	evaluating perl code specified by the user. This is true when urxvt was	481	whether they are started, being destroyed etc., so be careful. Only term
507	started setuid or setgid.	482	objects that have perl extensions attached will be returned (because there
		483	is no urxvt::term object associated with others).
508		484
509	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
510		486
511	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
512		488
…		…
555		531
556	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
557		533
558	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
559		535
560	=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
561		538
562	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
563	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
564	the bitset.	541	the bitset.
565		542
…		…
571		548
572	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	549	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
573		550
574	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	551	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
575		552
		553	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		554
576	Replace the foreground/background colour in the rendition mask with the	555	Replace the foreground/background colour in the rendition mask with the
577	specified one.	556	specified one.
578		557
579	=item $value = urxvt::GET_CUSTOM $rend	558	=item $value = urxvt::GET_CUSTOM $rend
580		559
…		…
589	=back	568	=back
590		569
591	=cut	570	=cut
592		571
593	BEGIN {	572	BEGIN {
594	urxvt->bootstrap;
595
596	# overwrite perl's warn	573	# overwrite perl's warn
597	*CORE::GLOBAL::warn = sub {	574	*CORE::GLOBAL::warn = sub {
598	my $msg = join "", @_;	575	my $msg = join "", @_;
599	$msg .= "\n"	576	$msg .= "\n"
600	unless $msg =~ /\n$/;	577	unless $msg =~ /\n$/;
601	urxvt::warn ($msg);	578	urxvt::warn ($msg);
602	};	579	};
		580	}
603		581
604	# %ENV is the original startup environment	582	no warnings 'utf8';
605	delete $ENV{IFS};	583
606	delete $ENV{CDPATH};	584	sub parse_resource {
607	delete $ENV{BASH_ENV};	585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
608	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	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	}
609	}	642	}
610		643
611	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
612		645
613	sub verbose {	646	sub verbose {
614	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
615	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
616	}	649	}
617		650
618	my $extension_pkg = "extension0000";
619	my %extension_pkg;	651	my %extension_pkg;
620		652
621	# load a single script into its own package, once only	653	# load a single script into its own package, once only
622	sub extension_package($) {	654	sub extension_package($) {
623	my ($path) = @_;	655	my ($path) = @_;
624		656
625	$extension_pkg{$path} ||= do {	657	$extension_pkg{$path} ||= do {
626	my $pkg = "urxvt::" . ($extension_pkg++);	658	$path =~ /([^\/\\]+)$/;
		659	my $pkg = $1;
		660	$pkg =~ s/[^[:word:]]/_/g;
		661	$pkg = "urxvt::ext::$pkg";
627		662
628	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
629		666
630	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
631	or die "$path: $!";	668	or die "$path: $!";
632		669
633	my $source = untaint	670	my $source =
634	"package $pkg; use strict; use utf8;\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
635	. "use base urxvt::term::extension::;\n"
636	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
637	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
638	. "\n};\n1";	674	. "\n};\n1";
639		675
640	eval $source	676	eval $source
…		…
650	sub invoke {	686	sub invoke {
651	local $TERM = shift;	687	local $TERM = shift;
652	my $htype = shift;	688	my $htype = shift;
653		689
654	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
655	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
656		692
657	my %ext_arg;	693	my %ext_arg;
658		694
		695	{
		696	my @init = @TERM_INIT;
		697	@TERM_INIT = ();
		698	$_->($TERM) for @init;
		699	my @pkg = @TERM_EXT;
		700	@TERM_EXT = ();
		701	$TERM->register_package ($_) for @pkg;
		702	}
		703
		704	for (
		705	@{ delete $TERM->{perl_ext_3} },
659	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
660	if ($_ eq "default") {	708	if ($_ eq "default") {
661	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	709	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
662	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
663	delete $ext_arg{$1};	711	delete $ext_arg{$1};
664	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
665	push @{ $ext_arg{$1} }, $2;	713	push @{ $ext_arg{$1} }, $2;
666	} else {	714	} else {
667	$ext_arg{$_} ||= [];	715	$ext_arg{$_} ||= [];
668	}	716	}
669	}	717	}
670		718
671	while (my ($ext, $argv) = each %ext_arg) {	719	for my $ext (sort keys %ext_arg) {
672	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
673		721
674	if (@files) {	722	if (@files) {
675	$TERM->register_package (extension_package $files[0], $argv);	723	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
676	} else {	724	} else {
677	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";
678	}	726	}
679	}	727	}
680		728
…		…
686		734
687	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
688	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
689	if $verbosity >= 10;	737	if $verbosity >= 10;
690		738
691	keys %$cb;	739	for my $pkg (keys %$cb) {
692
693	while (my ($pkg, $cb) = each %$cb) {
694	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
695	and last;	741	$retval ||= $retval_;
696		742
697	if ($@) {	743	if ($@) {
698	$TERM->ungrab; # better to lose the grab than the session	744	$TERM->ungrab; # better to lose the grab than the session
699	warn $@;	745	warn $@;
700	}	746	}
…		…
713	}	759	}
714		760
715	$retval	761	$retval
716	}	762	}
717		763
718	sub exec_async(@) {	764	sub SET_COLOR($$$) {
719	my $pid = fork;	765	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
720
721	return
722	if !defined $pid or $pid;
723
724	%ENV = %{ $TERM->env };
725
726	exec @_;
727	_exit 255;
728	}	766	}
729		767
730	# 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	}
731		792
732	package urxvt::term::extension;	793	package urxvt::term::extension;
733		794
734	sub enable {	795	sub enable {
735	my ($self, %hook) = @_;	796	my ($self, %hook) = @_;
…		…
790		851
791	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
792	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
793	}	854	}
794		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
795	package urxvt::anyevent;	868	package urxvt::anyevent;
796		869
797	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
798		871
799	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
800	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
801	further programming. The only exception is that you cannot wait on	874	further programming. The only exception is that you cannot wait on
802	condition variables, but non-blocking condvar use is ok. What this means	875	condition variables, but non-blocking condvar use is ok.
803	is that you cannot use blocking APIs, but the non-blocking variant should	876
804	work.	877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
805		879
806	=cut	880	=cut
807		881
808	our $VERSION = 1;	882	our $VERSION = '5.23';
809		883
810	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
811	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
812		886
813	sub timer {	887	sub timer {
…		…
815		889
816	my $cb = $arg{cb};	890	my $cb = $arg{cb};
817		891
818	urxvt::timer	892	urxvt::timer
819	->new	893	->new
820	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
821	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
822	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
823	$cb->();	897	$cb->();
824	})	898	})
825	}	899	}
826		900
827	sub io {	901	sub io {
828	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
829		903
830	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
831		907
832	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
833	->new	909	->new
834	->fd (fileno $arg{fh})	910	->fd ($fd)
835	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
836	| ($arg{poll} =~ /w/ ? 2 : 0))	912	| ($arg{poll} =~ /w/ ? 2 : 0))
837	->start	913	->start
838	->cb (sub {	914	->cb ($cb)
839	$cb->(($_[1] & 1 ? 'r' : '')
840	. ($_[1] & 2 ? 'w' : ''));
841	})],
842	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	})
843	}	941	}
844		942
845	sub DESTROY {	943	sub DESTROY {
846	$_[0][1]->stop;	944	$_[0][1]->stop;
847	}	945	}
848		946
849	sub condvar {	947	# only needed for AnyEvent < 6 compatibility
850	bless \my $flag, urxvt::anyevent::condvar::	948	sub one_event {
851	}
852
853	sub urxvt::anyevent::condvar::broadcast {
854	${$_[0]}++;
855	}
856
857	sub urxvt::anyevent::condvar::wait {
858	unless (${$_[0]}) {
859	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";
860	}
861	}	950	}
862		951
863	package urxvt::term;	952	package urxvt::term;
864		953
865	=head2 The C<urxvt::term> Class	954	=head2 The C<urxvt::term> Class
…		…
871	# find on_xxx subs in the package and register them	960	# find on_xxx subs in the package and register them
872	# as hooks	961	# as hooks
873	sub register_package {	962	sub register_package {
874	my ($self, $pkg, $argv) = @_;	963	my ($self, $pkg, $argv) = @_;
875		964
		965	no strict 'refs';
		966
		967	urxvt::verbose 6, "register package $pkg to $self";
		968
		969	@{"$pkg\::ISA"} = urxvt::term::extension::;
		970
876	my $proxy = bless {	971	my $proxy = bless {
877	_pkg => $pkg,	972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
878	argv => $argv,	974	argv => $argv,
879	}, $pkg;	975	}, $pkg;
880	Scalar::Util::weaken ($proxy->{term} = $self);	976	Scalar::Util::weaken ($proxy->{term} = $self);
881		977
882	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
883		979
…		…
886	$proxy->enable ($name => $ref);	982	$proxy->enable ($name => $ref);
887	}	983	}
888	}	984	}
889	}	985	}
890		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
891	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
892		1035
893	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
894	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
895	hash which defines the environment of the new terminal.	1038	hash which defines the environment of the new terminal.
896		1039
897	Croaks (and probably outputs an error message) if the new instance	1040	Croaks (and probably outputs an error message) if the new instance
898	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
899	initialise perl, and the terminal object otherwise. The C<init> and	1042	initialise perl, and the terminal object otherwise. The C<init> and
900	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).
901		1045
902	=cut	1046	=cut
903		1047
904	sub new {	1048	sub new {
905	my ($class, $env, @args) = @_;	1049	my ($class, $env, @args) = @_;
906		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
907	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1054	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
908	}	1055	}
909		1056
910	=item $term->destroy	1057	=item $term->destroy
911		1058
912	Destroy the terminal object (close the window, free resources	1059	Destroy the terminal object (close the window, free resources
913	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1060	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
914	watchers (timers, io watchers) are still active.	1061	watchers (timers, io watchers) are still active.
915		1062
		1063	=item $term->exec_async ($cmd[, @args])
		1064
		1065	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1066	("starts") programs in the background. This function takes care of setting
		1067	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1068	be preferred over explicit calls to C<exec> or C<system>.
		1069
		1070	Returns the pid of the subprocess or C<undef> on error.
		1071
		1072	=cut
		1073
		1074	sub exec_async {
		1075	my $self = shift;
		1076
		1077	my $pid = fork;
		1078
		1079	return $pid
		1080	if !defined $pid or $pid;
		1081
		1082	%ENV = %{ $self->env };
		1083
		1084	exec @_;
		1085	urxvt::_exit 255;
		1086	}
		1087
916	=item $isset = $term->option ($optval[, $set])	1088	=item $isset = $term->option ($optval[, $set])
917		1089
918	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
919	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
920	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.
921		1093
922	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
923	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
924		1096
925	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
926	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
927	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
928	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
929	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
930	tripleclickwords utmpInhibit visualBell	1103	urgentOnBell utmpInhibit visualBell
931		1104
932	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
933		1106
934	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
935	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>
…		…
944	likely change).	1117	likely change).
945		1118
946	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
947	terminal is destroyed, so changing options frequently will eat memory.	1120	terminal is destroyed, so changing options frequently will eat memory.
948		1121
949	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
950	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>
951	to see the actual list:	1124	to see the actual list:
952		1125
953	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius
954	borderLess color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
955	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
956	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
957	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
958	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
959	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
960	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
961	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
962	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
963	shade term_name title transparent transparent_all tripleclickwords	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1138	term_name title transient_for transparent tripleclickwords urgentOnBell
964	utmpInhibit visualBell	1139	utmpInhibit visualBell
965		1140
966	=cut	1141	=cut
967		1142
968	sub resource($$;$) {	1143	sub resource($$;$) {
969	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
970	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1145	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
971	&urxvt::term::_resource	1146	goto &urxvt::term::_resource
972	}	1147	}
973		1148
974	=item $value = $term->x_resource ($pattern)	1149	=item $value = $term->x_resource ($pattern)
975		1150
976	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
977	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
978	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
979	resource with that pattern exists.	1154	resource with that pattern exists.
980		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
981	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
982	only one resource database per display, and later invocations might return	1167	only one resource database per display, and later invocations might return
983	the wrong resources.	1168	the wrong resources.
984		1169
985	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1170	=item $value = $term->x_resource_boolean ($pattern)
986		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
987	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
988	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.
989		1197
990	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
991		1199
992	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
993	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
1001		1209
1002	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
1003		1211
1004	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
1005		1213
1006	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.
1007	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.
1008		1223
1009	=item $term->selection_make ($eventtime[, $rectangular])	1224	=item $term->selection_make ($eventtime[, $rectangular])
1010		1225
1011	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
1012	C<selection_end>. If C<$rectangular> is true (default: false), a	1227	C<selection_end>. If C<$rectangular> is true (default: false), a
1013	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
1014	a selection.	1229	a selection.
1015		1230
1016	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1017		1232
1018	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
1019	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
1020	is mostly useful from within C<on_sel_grab> hooks.	1236	is mostly useful from within C<on_sel_grab> hooks.
1021		1237
1022	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
1023		1239
1024	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.
1025		1246
1026	=item $term->overlay_simple ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
1027		1248
1028	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.
1029		1250
…		…
1059		1280
1060	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
1061		1282
1062	=over 4	1283	=over 4
1063		1284
1064	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
1065		1286
1066	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
1067	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
1068	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.
1069		1292
1070	=item $overlay->hide	1293	=item $overlay->hide
1071		1294
1072	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
1073		1296
…		…
1143		1366
1144	Normally its not a good idea to use this function, as programs might be	1367	Normally its not a good idea to use this function, as programs might be
1145	confused by changes in cursor position or scrolling. Its useful inside a	1368	confused by changes in cursor position or scrolling. Its useful inside a
1146	C<on_add_lines> hook, though.	1369	C<on_add_lines> hook, though.
1147		1370
		1371	=item $term->scr_change_screen ($screen)
		1372
		1373	Switch to given screen - 0 primary, 1 secondary.
		1374
1148	=item $term->cmd_parse ($octets)	1375	=item $term->cmd_parse ($octets)
1149		1376
1150	Similar to C<scr_add_lines>, but the argument must be in the	1377	Similar to C<scr_add_lines>, but the argument must be in the
1151	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
1152	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
1153		1380
1154	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
1155		1382
1156	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
1157	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
1158	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.
1159		1392
1160	=item $old_events = $term->pty_ev_events ([$new_events])	1393	=item $old_events = $term->pty_ev_events ([$new_events])
1161		1394
1162	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
1163	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
1164	description of C<< urxvt::timer->events >>. Make sure to always restore	1397	description of C<< urxvt::timer->events >>. Make sure to always restore
1165	the previous value.	1398	the previous value.
1166		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
1167	=item $windowid = $term->parent	1405	=item $windowid = $term->parent
1168		1406
1169	Return the window id of the toplevel window.	1407	Return the window id of the toplevel window.
1170		1408
1171	=item $windowid = $term->vt	1409	=item $windowid = $term->vt
…		…
1177	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
1178	to receive pointer events all the times:	1416	to receive pointer events all the times:
1179		1417
1180	$term->vt_emask_add (urxvt::PointerMotionMask);	1418	$term->vt_emask_add (urxvt::PointerMotionMask);
1181		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
1182	=item $window_width = $term->width	1434	=item $window_width = $term->width
1183		1435
1184	=item $window_height = $term->height	1436	=item $window_height = $term->height
1185		1437
1186	=item $font_width = $term->fwidth	1438	=item $font_width = $term->fwidth
…		…
1216	=item $env = $term->env	1468	=item $env = $term->env
1217		1469
1218	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
1219	similar to C<\%ENV>.	1471	similar to C<\%ENV>.
1220		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
1221	=cut	1482	=cut
1222		1483
1223	sub env {	1484	sub env {
1224	if (my $env = $_[0]->_env) {
1225	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1485	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1226	} else {
1227	+{ %ENV }
1228	}
1229	}	1486	}
1230		1487
1231	=item $modifiermask = $term->ModLevel3Mask	1488	=item $modifiermask = $term->ModLevel3Mask
1232		1489
1233	=item $modifiermask = $term->ModMetaMask	1490	=item $modifiermask = $term->ModMetaMask
1234		1491
1235	=item $modifiermask = $term->ModNumLockMask	1492	=item $modifiermask = $term->ModNumLockMask
1236		1493
1237	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1494	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1238	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1495	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1496
		1497	=item $screen = $term->current_screen
		1498
		1499	Returns the currently displayed screen (0 primary, 1 secondary).
		1500
		1501	=item $cursor_is_hidden = $term->hidden_cursor
		1502
		1503	Returns whether the cursor is currently hidden or not.
1239		1504
1240	=item $view_start = $term->view_start ([$newvalue])	1505	=item $view_start = $term->view_start ([$newvalue])
1241		1506
1242	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
1243	C<0>, which displays the normal terminal contents. Lower values scroll	1508	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1251		1516
1252	Used after changing terminal contents to display them.	1517	Used after changing terminal contents to display them.
1253		1518
1254	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1255		1520
1256	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 >>
1257	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
1258	terminal line. The scrollback buffer starts at line C<-1> and extends to
1259	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1523	terminal line. Nothing will be returned if a nonexistent line
1260	is requested.	1524	is requested.
1261		1525
1262	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
1263	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
1264	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
1265	automatically be updated.	1529	automatically be updated.
1266		1530
1267	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
1268	than one cell when displayed are padded with urxvt::NOCHAR characters	1532	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1269	(C<chr 65535>). Characters with combining characters and other characters	1533	characters. Characters with combining characters and other characters that
1270	that do not fit into the normal tetx encoding will be replaced with	1534	do not fit into the normal text encoding will be replaced with characters
1271	characters in the private use area.	1535	in the private use area.
1272		1536
1273	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
1274	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
1275	characters.	1539	characters.
1276		1540
…		…
1420	where one character corresponds to one screen cell. See	1684	where one character corresponds to one screen cell. See
1421	C<< $term->ROW_t >> for details.	1685	C<< $term->ROW_t >> for details.
1422		1686
1423	=item $string = $term->special_decode $text	1687	=item $string = $term->special_decode $text
1424		1688
1425	Converts rxvt-unicodes text reprsentation into a perl string. See	1689	Converts rxvt-unicodes text representation into a perl string. See
1426	C<< $term->ROW_t >> for details.	1690	C<< $term->ROW_t >> for details.
1427		1691
1428	=item $success = $term->grab_button ($button, $modifiermask)	1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1429		1693
		1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1695
1430	Registers a synchronous button grab. See the XGrabButton manpage.	1696	Register/unregister a synchronous button grab. See the XGrabButton
		1697	manpage.
1431		1698
1432	=item $success = $term->grab ($eventtime[, $sync])	1699	=item $success = $term->grab ($eventtime[, $sync])
1433		1700
1434	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1701	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1435	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1702	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1436		1703
1437	=item $term->allow_events_async	1704	=item $term->allow_events_async
1438		1705
1439	Calls XAllowEvents with AsyncBoth for the most recent grab.	1706	Calls XAllowEvents with AsyncBoth for the most recent grab.
1440		1707
…		…
1447	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1448	recent grab.	1715	recent grab.
1449		1716
1450	=item $term->ungrab	1717	=item $term->ungrab
1451		1718
1452	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
1453	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
1454	the session.	1721	the session.
		1722
		1723	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1724
		1725	=item $atom_name = $term->XGetAtomName ($atom)
		1726
		1727	=item @atoms = $term->XListProperties ($window)
		1728
		1729	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1730
		1731	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1732
		1733	=item $term->XDeleteProperty ($window, $property)
		1734
		1735	=item $window = $term->DefaultRootWindow
		1736
		1737	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1738
		1739	=item $term->XMapWindow ($window)
		1740
		1741	=item $term->XUnmapWindow ($window)
		1742
		1743	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1744
		1745	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1746
		1747	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1748
		1749	=item $keysym = $term->XStringToKeysym ($string)
		1750
		1751	=item $string = $term->XKeysymToString ($keysym)
		1752
		1753	Various X or X-related functions. The C<$term> object only serves as
		1754	the source of the display, otherwise those functions map more-or-less
		1755	directly onto the X functions of the same name.
1455		1756
1456	=back	1757	=back
1457		1758
1458	=cut	1759	=cut
1459		1760
…		…
1523	my ($self, $text, $cb) = @_;	1824	my ($self, $text, $cb) = @_;
1524		1825
1525	$self->add_item ({ type => "button", text => $text, activate => $cb});	1826	$self->add_item ({ type => "button", text => $text, activate => $cb});
1526	}	1827	}
1527		1828
1528	=item $popup->add_toggle ($text, $cb, $initial_value)	1829	=item $popup->add_toggle ($text, $initial_value, $cb)
1529		1830
1530	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
1531	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
1532	argument.	1833	first argument.
1533		1834
1534	=cut	1835	=cut
1535		1836
1536	sub add_toggle {	1837	sub add_toggle {
1537	my ($self, $text, $cb, $value) = @_;	1838	my ($self, $text, $value, $cb) = @_;
1538		1839
1539	my $item; $item = {	1840	my $item; $item = {
1540	type => "button",	1841	type => "button",
1541	text => " $text",	1842	text => " $text",
1542	value => $value,	1843	value => $value,
…		…
1561	my $env = $self->{term}->env;	1862	my $env = $self->{term}->env;
1562	# 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.
1563	delete $env->{LC_ALL};	1864	delete $env->{LC_ALL};
1564	$env->{LC_CTYPE} = $self->{term}->locale;	1865	$env->{LC_CTYPE} = $self->{term}->locale;
1565		1866
1566	urxvt::term->new ($env, $self->{term}->resource ("name"),	1867	my $term = urxvt::term->new (
1567	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1868	$env, "popup",
		1869	"--perl-lib" => "", "--perl-ext-common" => "",
		1870	"-pty-fd" => -1, "-sl" => 0,
		1871	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1568	"--transient-for" => $self->{term}->parent,	1872	"--transient-for" => $self->{term}->parent,
1569	"-display" => $self->{term}->display_id,	1873	"-display" => $self->{term}->display_id,
1570	"-pe" => "urxvt-popup")	1874	"-pe" => "urxvt-popup",
1571	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	}
1572	}	1882	}
1573		1883
1574	sub DESTROY {	1884	sub DESTROY {
1575	my ($self) = @_;	1885	my ($self) = @_;
1576		1886
1577	delete $self->{term}{_destroy}{$self};	1887	delete $self->{term}{_destroy}{$self};
1578	$self->{term}->ungrab;	1888	$self->{term}->ungrab;
1579	}	1889	}
1580		1890
1581	=back	1891	=back
		1892
		1893	=cut
		1894
		1895	package urxvt::watcher;
1582		1896
1583	=head2 The C<urxvt::timer> Class	1897	=head2 The C<urxvt::timer> Class
1584		1898
1585	This class implements timer watchers/events. Time is represented as a	1899	This class implements timer watchers/events. Time is represented as a
1586	fractional number of seconds since the epoch. Example:	1900	fractional number of seconds since the epoch. Example:
…		…
1590	->new	1904	->new
1591	->interval (1)	1905	->interval (1)
1592	->cb (sub {	1906	->cb (sub {
1593	$term->{overlay}->set (0, 0,	1907	$term->{overlay}->set (0, 0,
1594	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1595	});	1909	});
1596		1910
1597	=over 4	1911	=over 4
1598		1912
1599	=item $timer = new urxvt::timer	1913	=item $timer = new urxvt::timer
1600		1914
…		…
1603		1917
1604	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1605		1919
1606	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
1607		1921
1608	=item $tstamp = $timer->at
1609
1610	Return the time this watcher will fire next.
1611
1612	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
1613		1923
1614	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).
1615		1926
1616	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
1617		1928
1618	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
1619	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
1620	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
1621		1932
1622	=item $timer = $timer->start	1933	=item $timer = $timer->start
1623		1934
1624	Start the timer.	1935	Start the timer.
1625		1936
1626	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
1627		1938
1628	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.
		1941
		1942	=item $timer = $timer->after ($delay[, $interval])
		1943
		1944	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1629		1945
1630	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
1631		1947
1632	Stop the timer.	1948	Stop the timer.
1633		1949
…		…
1639		1955
1640	$term->{socket} = ...	1956	$term->{socket} = ...
1641	$term->{iow} = urxvt::iow	1957	$term->{iow} = urxvt::iow
1642	->new	1958	->new
1643	->fd (fileno $term->{socket})	1959	->fd (fileno $term->{socket})
1644	->events (urxvt::EVENT_READ)	1960	->events (urxvt::EV_READ)
1645	->start	1961	->start
1646	->cb (sub {	1962	->cb (sub {
1647	my ($iow, $revents) = @_;	1963	my ($iow, $revents) = @_;
1648	# $revents must be 1 here, no need to check	1964	# $revents must be 1 here, no need to check
1649	sysread $term->{socket}, my $buf, 8192	1965	sysread $term->{socket}, my $buf, 8192
…		…
1662	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>
1663	is a bitset as described in the C<events> method.	1979	is a bitset as described in the C<events> method.
1664		1980
1665	=item $iow = $iow->fd ($fd)	1981	=item $iow = $iow->fd ($fd)
1666		1982
1667	Set the filedescriptor (not handle) to watch.	1983	Set the file descriptor (not handle) to watch.
1668		1984
1669	=item $iow = $iow->events ($eventmask)	1985	=item $iow = $iow->events ($eventmask)
1670		1986
1671	Set the event mask to watch. The only allowed values are	1987	Set the event mask to watch. The only allowed values are
1672	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
1673	together, or C<urxvt::EVENT_NONE>.	1989	together, or C<urxvt::EV_NONE>.
1674		1990
1675	=item $iow = $iow->start	1991	=item $iow = $iow->start
1676		1992
1677	Start watching for requested events on the given handle.	1993	Start watching for requested events on the given handle.
1678		1994
1679	=item $iow = $iow->stop	1995	=item $iow = $iow->stop
1680		1996
1681	Stop watching for events on the given filehandle.	1997	Stop watching for events on the given file handle.
		1998
		1999	=back
		2000
		2001	=head2 The C<urxvt::iw> Class
		2002
		2003	This class implements idle watchers, that get called automatically when
		2004	the process is idle. They should return as fast as possible, after doing
		2005	some useful work.
		2006
		2007	=over 4
		2008
		2009	=item $iw = new urxvt::iw
		2010
		2011	Create a new idle watcher object in stopped state.
		2012
		2013	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2014
		2015	Set the callback to be called when the watcher triggers.
		2016
		2017	=item $timer = $timer->start
		2018
		2019	Start the watcher.
		2020
		2021	=item $timer = $timer->stop
		2022
		2023	Stop the watcher.
		2024
		2025	=back
		2026
		2027	=head2 The C<urxvt::pw> Class
		2028
		2029	This class implements process watchers. They create an event whenever a
		2030	process exits, after which they stop automatically.
		2031
		2032	my $pid = fork;
		2033	...
		2034	$term->{pw} = urxvt::pw
		2035	->new
		2036	->start ($pid)
		2037	->cb (sub {
		2038	my ($pw, $exit_status) = @_;
		2039	...
		2040	});
		2041
		2042	=over 4
		2043
		2044	=item $pw = new urxvt::pw
		2045
		2046	Create a new process watcher in stopped state.
		2047
		2048	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2049
		2050	Set the callback to be called when the timer triggers.
		2051
		2052	=item $pw = $timer->start ($pid)
		2053
		2054	Tells the watcher to start watching for process C<$pid>.
		2055
		2056	=item $pw = $pw->stop
		2057
		2058	Stop the watcher.
1682		2059
1683	=back	2060	=back
1684		2061
1685	=head1 ENVIRONMENT	2062	=head1 ENVIRONMENT
1686		2063
…		…
1695		2072
1696	=item >= 3 - script loading and management	2073	=item >= 3 - script loading and management
1697		2074
1698	=item >=10 - all called hooks	2075	=item >=10 - all called hooks
1699		2076
1700	=item >=11 - hook reutrn values	2077	=item >=11 - hook return values
1701		2078
1702	=back	2079	=back
1703		2080
1704	=head1 AUTHOR	2081	=head1 AUTHOR
1705		2082
1706	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
1707	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
1708		2085
1709	=cut	2086	=cut
1710		2087
1711	1	2088	1
		2089
		2090	# vim: sw=3:

Diff Legend

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